Skip to content

Split the Developer Guide into searchable Hugo chapters - #5860

Merged
shai-almog merged 4 commits into
masterfrom
developer-guide-chapter-pages
Sep 18, 2026
Merged

shai-almog merged 4 commits into
masterfrom
developer-guide-chapter-pages

Conversation

@shai-almog

@shai-almog shai-almog commented Sep 18, 2026

Copy link
Copy Markdown
Collaborator

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:

  • Production and future-enabled Hugo website builds with guide generation enabled (WEBSITE_INCLUDE_SKINDESIGNER=false).
  • Generator regression tests covering cross-chapter references, inline anchors, code, images, tables, callouts, and footnotes.
  • Rendered link and asset validation, all bookmark routes, legacy chapter redirects, and all 94 chapter search entries.
  • Existing developer-guide PDF redirect tests.
  • Chromium checks for desktop/mobile layouts, light/dark themes, contents and topic links, active chapter visibility, top/bottom previous/next links, keyboard navigation, responsive menus, old bookmarks, images, and footnotes.
  • Cloudflare Pages runtime checks for legacy Javadoc URLs, plus redirect-order regression tests.
  • git diff --check.

The generator regression tests, redirect-order tests, and rendered guide checks are included in the website CI workflow.

@github-actions

Copy link
Copy Markdown
Contributor

Blog prose gate

✅ No net-new prose findings introduced by this PR.

@shai-almog

Copy link
Copy Markdown
Collaborator Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Another round soon, please!

Reviewed commit: 30de790176

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

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".

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-18T15:12:51.690066Z 30de790 Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

github-actions Bot commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

✅ Continuous Quality Report

Test & Coverage

Static Analysis

  • SpotBugs [Report archive]
    • ByteCodeTranslator: 0 findings (no issues)
    • android: 0 findings (no issues)
    • build-hint-catalog: 0 findings (no issues)
    • build-hint-tools: 0 findings (no issues)
    • codenameone-maven-plugin: 0 findings (no issues)
    • core-unittests: 0 findings (no issues)
    • ios: 0 findings (no issues)
  • PMD: 0 findings (no issues) [Report archive]
  • Checkstyle: 0 findings (no issues) [Report archive]

Generated automatically by the PR CI workflow.

@github-actions

Copy link
Copy Markdown
Contributor

Cloudflare Preview

@github-actions

Copy link
Copy Markdown
Contributor

Developer Guide build artifacts are available for download from this workflow run:

Developer Guide quality checks:

  • AsciiDoc linter: No issues found (report)
  • Vale: No alerts found (report)
  • Paragraph capitalization: No paragraph capitalization issues (report)
  • LanguageTool: No grammar matches (report)
  • Image references: No unused images detected (report)

@shai-almog
shai-almog merged commit 5800e73 into master Sep 18, 2026
20 checks passed
@shai-almog
shai-almog deleted the developer-guide-chapter-pages branch September 18, 2026 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant