Repository navigation
Move README reference sections into guides (cleanup S2b) - #228
Merged
Merged
Conversation
README keeps the newcomer path (languages, build and run, configuration) and points to the new homes: docs/reference/mcp-and-rest.md, docs/reference/cli.md, docs/reference/retrieval.md and docs/development/module-boundaries.md. Moved text is unchanged apart from relative link targets. README 370 -> 233 lines. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…s sections Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…example Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Cleanup after cycle 1, slice S2b (docs only).
docs/reference/mcp-and-rest.md: "MCP tools" (with "Language-server lifecycle") and "REST/OpenAPI surface"docs/reference/cli.md: "CLI"docs/reference/retrieval.md: "Retrieval behavior" and "Retrieval evaluation"docs/development/module-boundaries.md: "Module boundaries and checks"documentation.mdrule 2 names the new homes.Information-loss check: a section and token inventory of every tracked Markdown file before and after shows no change in ids, PR numbers, numbers, dates, statuses, conditions or negations. Only relative link targets changed with the new file depth. A separate review compared the moved text line by line, and the only differences are the deliberate repoints.
cargo xtask docs check: 79 files, 266 relative links, 0 problems.Not in this PR: Rust strings that name README sections (
src/rest.rsOpenAPI descriptions, which a golden pins;xtaskhelp;config/profile.rscomments), plus fact mismatches against the code. Both come in the next cleanup slice.🤖 Generated with Claude Code