Repository navigation
docs: README as a front door, reference moved into docs/ - #297
Merged
Merged
Conversation
README drops from 555 to 163 lines: pitch, first minute (examples re-run on 4.8.0), install one-liners, common commands, agent integration and a task-organised "Go deeper" table. Reference text moved essentially unchanged into docs/INSTALL.md, RESOLUTION.md, COMMANDS.md and CONFIG.md; the README's MCP and Codex sections merged into docs/MCP.md (tool count corrected to 19). User docs open with the question they answer and chain INSTALL -> HOOKS -> RESOLUTION -> COMMANDS -> CONFIG -> MCP. Session ledger specs move to docs/design/. CONTRIBUTING's "Adding a New Language" pointed at scanner/queries/ and scanner/grammar.go, removed with tree-sitter in 5473226; it now lists the sg-rules file, language maps and conformance case a language needs. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FWQw8DzwM4bQnL7mvk6Fsq
Rendered from the real codemap output on this branch, so the docs/ listing matches the new layout. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FWQw8DzwM4bQnL7mvk6Fsq
Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FWQw8DzwM4bQnL7mvk6Fsq
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.
What
The README goes from 555 lines to 163. It keeps the pitch, "Your agent's first minute", install, the commands people run, and a "Go deeper" table by task. The reference material moves into
docs/, one job per file, mostly unchanged.docs/INSTALL.md(new)codemap setupwrites, verifydocs/RESOLUTION.md(new)docs/COMMANDS.md(new)docs/CONFIG.md(new)docs/MCP.mddocs/HOOKS.mddocs/design/git mvEach user doc opens with the question it answers and ends with one Next link: INSTALL, HOOKS, RESOLUTION, COMMANDS, CONFIG, MCP.
Corrections made along the way
codemap .excerpt shows the new tree;--importers config/config.gonow reports 42 importers (was 40, and 21 in a second copy);findoutput updated.docs/COMMANDS.mdgains 9 flags that--helplists and the old table did not.docs/MCP.mdtool count is 19 (was 17) and listsfind,get_topology,get_module_context.CONTRIBUTING.md"Adding a New Language" pointed atscanner/queries/andscanner/grammar.go, removed in 5473226. It now lists the ast-grep rule file, the language maps, and the conformance test case.Removed, not moved
docs/MCP.mdalready has per-category tables).docs/HOOKS.md).Not done here
assets/codemap.pngstill shows the pre-4.8.0 tree.Makefilegrammars/depstargets still call the deletedbuild-grammars.sh.--max-fileshelp text inmain.gosays 50000; the real default is 100000. Docs say 100000.Test
go test ./...passes. Every relative link and anchor in README, CONTRIBUTING anddocs/*.mdresolves.🤖 Generated with Claude Code
https://claude.ai/code/session_01FWQw8DzwM4bQnL7mvk6Fsq