Repository navigation
Move the documentation from MkDocs to AsciiDoc, published on smallrye.io - #376
phillip-kruger wants to merge 1 commit into
Conversation
|
Screenshots of the documentation before and after this change (updated). Before: the MkDocs site, as it is on smallrye.io today. After: this branch's AsciiDoc, rendered by smallrye.io with smallrye/smallrye.github.io#136 (a local build:
Dark theme: the same screenshots with the dark themeThe old Antora sites and the GraphQL, Vert.x bindings and Mutiny Zero MkDocs sites have no dark theme, so their "before" stays light; the other old MkDocs sites were switched to their own dark palette.
|
||||||||||||||||||||||||||||||||
e352e70 to
6ebabb5
Compare
6ebabb5 to
488413d
Compare
488413d to
bb2006a
Compare












The docs move from MkDocs to AsciiDoc, laid out like the Quarkus guides. smallrye.io pulls them in and publishes them at https://smallrye.io/docs/smallrye-mutiny-zero// (smallrye/smallrye.github.io#136):
mainnightly, each release once it is tagged.Depends on smallrye/smallrye.github.io#136. The new Documentation check calls the reusable workflow added there.
What changes
docs/*.mdbecomedocs/src/main/asciidoc/*.adocwith the same names, so the same addresses; the sidebar is_nav.yml, shared attributes are in_attributes.adoc, images stay underassets/.src/test/java/docsamples(compiled and run by the build) and are included withinclude::{examples-dir}/...[].docs/or the samples run the new Documentation workflow: it renders the docs with the smallrye.io site, fails on a broken include or a page that does not render, and attaches the rendered site.mkdocs.yml, the theme override,pyproject.toml/uv.lock, the mike Publish the website workflow and.github/scripts/render-documentation.sh. Releases no longer publish docs; smallrye.io picks up the tag.docs/README.adocexplains how to write and preview pages; the README links to the new location.Older versions
Everything already on
gh-pages(1.3.1 and earlier) stays where it is, and the site's version picker links to it. After this is merged, the mikelatestalias and the root page ongh-pageswill redirect to/docs/smallrye-mutiny-zero/latest/.Checked
Rendered with the smallrye.io site: no errors or Asciidoctor warnings, all internal links and images resolve.