Convert AsciiDoc documentation to Markdown - #12389
Merged
romain-grecourt merged 2 commits intoSep 1, 2026
Merged
Conversation
Member
|
Of the five review findings, these two are blockers and should be fixed as part of this PR before merge:
The remaining three findings can be addressed in a follow-up PR:
|
This was referenced Aug 31, 2026
Convert AsciiDoc documentation to Markdown. The Markdown is flavored using HTML comment directives so the source still renders as vanilla Markdown. On `main`, the former SE content is published under the top-level Modules and Guides sections. This forward-port includes the reconciled main-branch documentation updates. The configuration documentation generator now outputs Markdown instead of AsciiDoc, with simpler anchor handling for included pages. Generated configuration docs are checked in under `docs/config`, and CI regenerates them and fails if the checked-in output is out of date. Aggregate Javadocs are generated by the dedicated `javadocs/pom.xml` module instead of `docs/pom.xml`.
romain-grecourt
force-pushed
the
main-docs-markdown
branch
from
August 31, 2026 21:47
6ff3f8c to
084b525
Compare
romain-grecourt
force-pushed
the
main-docs-markdown
branch
from
September 1, 2026 00:00
084b525 to
dace721
Compare
barchetta
approved these changes
Sep 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Forward-port #12220 to
main, converting AsciiDoc documentation toMarkdown.
The Markdown is flavored using HTML comment directives so the source still
renders as vanilla Markdown.
On
main, the former Helidon SE content is published under the top-levelModules and Guides sections. This forward-port also includes the reconciled
main-branch documentation updates.
The configuration documentation generator now outputs Markdown instead of
AsciiDoc, with simpler anchor handling for included pages. Generated
configuration docs are checked in under
docs/config, and CI regenerates themand fails if the checked-in output is out of date.
Aggregate Javadocs are generated from the dedicated
javadocs/pom.xmlmoduleinstead of
docs/pom.xml.Documentation
This pull request is the
mainforward-port of the documentation conversionin #12220. It publishes the former SE documentation as top-level Modules and
Guides, including generated Markdown configuration references.
Validation
Validation included:
generation, and the CI freshness check for checked-in
docs/configoutput;zero actionable findings; and