Split the Developer Guide into searchable Hugo chapters - #5860
Conversation
Blog prose gate✅ No net-new prose findings introduced by this PR. |
|
@codex review |
|
Codex Review: Didn't find any major issues. Another round soon, please! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
✅ Continuous Quality ReportTest & Coverage
Static Analysis
Generated automatically by the PR CI workflow. |
Cloudflare Preview
|
|
Developer Guide build artifacts are available for download from this workflow run:
Developer Guide quality checks: |
The Developer Guide currently loads as one large document, and many website links either point to its top or to retired
/manual/chapter URLs. This change publishes 94 chapter pages through Hugo, with a persistent chapter sidebar, a numbered contents page with topic links, section tables of contents, and searchable chapter content. Previous/next arrows appear at both the top and bottom of every chapter. On mobile, the chapter menu collapses above the reading area.The existing AsciiDoc book remains the source for the PDF and website. The build generates Markdown headings and ordinary code blocks, preserving rich AsciiDoc blocks through a scoped HTML shortcode. Generated content stays out of Git. The full-book view remains available at
/developer-guide/single-page/and is excluded from search to avoid duplicate results.Website, tutorial, course, pricing, and blog links now point to relevant chapters or sections. The Markdown link renderer also resolves legacy links in generated Javadoc comments. Legacy chapter redirects and 1,720 bookmark routes preserve existing section links; fragment routing uses JavaScript because fragments are not sent to the server.
Validation:
WEBSITE_INCLUDE_SKINDESIGNER=false).git diff --check.The generator regression tests, redirect-order tests, and rendered guide checks are included in the website CI workflow.