Checks that the docs entry pages (Getting Started, Ecosystem, Framework Comparisons, Why Juneau, the home page, the About pages, JuneauMarshall, REST server, Microservice, MCP quickstart, Petstore and Starter Projects) tell one story: one format count tied to the marshaller classes, one canonical first resource, the documented ports, and no comparison claim that Framework Comparisons does not support.
build-docs.py runs it as the “Entry pages” child row of its Verify stage, including under --skip-maven.check-java-fences.py; for the About hub's structure, check-project-pages.py.python3 scripts/check-entry-pages.py --juneau-root ~/git/apache/juneau python3 scripts/check-entry-pages.py # K1b skipped if no Juneau checkout is found python3 scripts/check-entry-pages.py --docs-root /path/to/juneau-docs
| Option | Argument | Default | Meaning |
|---|---|---|---|
--juneau-root | directory | $JUNEAU_ROOT, then ../master, then ../juneau | The Juneau checkout whose marshaller packages K1b counts. K1b is skipped (with a note, not a failure) if both packages are not under it. |
--docs-root | directory | parent of the scripts/ folder | The docs checkout to check. |
The entry pages are the 15 files in ENTRY_PAGES plus src/pages/about/*.mdx (or src/pages/about.md when there are none). src/pages/about/index.mdx is the redirect stub to the home page and is not counted; K0's “there is an About page” means at least one project page. “Prose” is a file with its fenced blocks blanked; fences are read with code_fences.iter_fences, language = first word of the info string.
N formats / N+ formats (optionally a link, optionally followed by (C in ..., R RDF ...)) has no +, N equals the JuneauMarshall badge total, and C and R equal the core and RDF badge counts. A badge linking to /docs/topics/Rdf is RDF; the rest are core.public [final] class X extends CharMarshaller|StreamMarshaller) directly in juneau-marshall's and juneau-marshall-rdf's marshaller packages. Today: 26 + 12 = 38. SOAP (serializer only) and JsonPatchMarshaller (JSON, in juneau-bean-jsonpatch) are not formats.pages/**/*.md and src/pages/**, less release notes): no /swagger-ui.html, no Java-serialized-object. K2b (Java fences in pages/** and src/pages/about/*.mdx, less release notes): no org.apache.juneau.rest.annotation.about/rest-server.mdx if present): K3a no bare @Path in a Java fence; K3b extends BasicRestResource in a Java fence only if the page links to /docs/topics/GettingStartedRestApp#servlet-or-resource; K3c no juneau-shaded-all in an XML fence.localhost:<port> is 10000, 8080 or 5000. K4b: the MCP quickstart uses only 10000.zero configuration, zero-dependency, zero dependencies, minimal memory footprint, fast startup, productive immediately, fewer security vulnerabilities, complex annotation system, minimal dependencies.scripts/check-entry-pages-allowlist.txt (path<TAB>rule<TAB>literal<TAB>reason, matched on path, rule and literal, not line). A malformed or unused entry is itself a failure.One line per failure, sorted: path:line: rule: message. Then any notes (K1b skipped: no Juneau checkout at <path>), then Entry pages checked: N; failures: M.
| Code | Meaning |
|---|---|
| 0 | No failures (K1b may have been skipped). |
| 1 | Any K0-K5 failure, or a malformed or stale allow-list entry. An explicit --juneau-root that is not a Juneau checkout (no pom.xml) also exits 1. |
JsonPatchMarshaller too, but it is not in the two counted packages.formats. “12 RDF formats” and “26 wire formats” are not counts to it, so write counts in the canonical phrase: 38 formats (26 in juneau-marshall, 12 RDF in juneau-marshall-rdf).build-docs.py (runs it in Verify), check-project-pages.py, verify-docs.py, check-java-fences.pypages/topics/03.00.JuneauMarshall.md