Add agent-readable Markdown links - #19
Conversation
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Documentation previewThe preview has been removed. |
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Panel review resultsReview target: Panel
Data/migrations, API contracts, performance/concurrency, and dependency/supply-chain lenses were skipped as inapplicable to this static documentation build change. Findings and resolutionThe first round identified one shared issue: the maintainer guide said to exclude all section landing pages, while the implementation intentionally treats every page in the two canonical content directories as publishable, including the Documentation index.
Both affected reviewers reran against Validation
Final verdict: clean and merge-ready. No unresolved panel findings remain. |
Summary
rel="alternate"discovery linksWhy
Agents consuming the documentation should be able to discover and fetch the underlying Markdown without parsing rendered page chrome. Zensical’s built-in source action points at a repository branch, which can become stale on pull-request previews, so the build publishes the matching Markdown artifact alongside each eligible page.
Impact
Canonical pages under
docs/dev-notes/posts/anddocs/documentation/opt into Markdown publication withagent_markdown: true. Landing pages, redirects, obsolete pages, internal development pages, and the 404 page remain excluded.Validation
python3 -m unittest discover -s testsscripts/build-docs.shgit diff --check/documentation/index.mdreturning200 OKwithContent-Type: text/markdown