Repository navigation
Docs: give the docs/ folder an index page, checked by cargo xtask docs to name every guide - #629
Merged
Merged
Conversation
https://github.com/forgepkg/forge/tree/main/docs listed the guides as bare files, next to SUMMARY.md and book.toml, with nothing saying what each covers. docs/README.md is that index now: the guides by part, as SUMMARY.md groups them, a line on each, and links to the site, the README and the changelog. It is no page of the site, which has a start page and a sidebar of its own; staged, it would be readme.md, which mdBook turns into index.md, the README's name there. `cargo xtask docs` no longer counts it as a guide SUMMARY.md leaves out, checks its links as a page's, and fails when it does not link a page SUMMARY.md lists, so a new guide cannot be missing from it. DEVELOPMENT.md says so. Fixes #628 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012e6DJbNRFYp72ZsDpL9kCF
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.
Fixes #628
https://github.com/forgepkg/forge/tree/main/docs listed the guides as bare files, next to
SUMMARY.mdandbook.toml, with nothing saying what each covers.Changes
docs/README.md, which GitHub shows under the folder's files. It groups the guides by part asSUMMARY.mddoes (Running Forge, Formats, CI and publishing, Releases), gives each a line, and links the site, the README (and its quickstart, for NuGet, which has no guide of its own), DEVELOPMENT.md and the changelog.readme.md, which mdBook turns intoindex.md: the README's name there.cargo xtask docs(xtask/src/docs.rs):docs/README.mdas a guideSUMMARY.mdleaves out;SUMMARY.mdlists, so a new guide cannot be missing from it.DEVELOPMENT.md(Documentation site) and the comment on CI's docs step say so.docs/changes/2.1.1/628.docs.md.Testing
cargo xtask docs --check→12 page(s) of the site, every link resolves.docs/README.md, and the check failed withdocs/README.md: links no docs/retention.md, which docs/SUMMARY.md lists. I then restored the line.cargo test -p xtask: the newthe_docs_index_is_no_page_but_links_every_pagecovers both sides. An index that links every page passes and is not staged; one with a missing heading, a missing file and two pages left out fails with all four problems, and never with "no page of the site".cargo xtask changelog --check,cargo fmt --all --check,cargo clippy -p xtask --all-targets -- -D warnings.The site's output does not change:
docs/README.mdis not staged, so mdBook never sees it. I did not run mdBook itself;--checkcovers the staging.Generated by Claude Code