docs: overhaul README around the ground-and-govern positioning#21
Merged
Conversation
Rewrite the README from an 830-line reference manual into a lean ~285-line front door aligned with docs.agentis.tools and the canonical positioning in docs/messaging.md. - Lead with the pain + 'local quality authority for AI-written code' thesis, unpacked into scannable Ground/Govern bullets with a concrete proof number. - Replace the stale 'Two Tools in One' framing with 'One model, two jobs'; fold context generation in as one capability under Ground. - Feature the Claude Code harness loop (ctx harness init) as a headline. - Compact command table linking to the docs instead of ~25 per-command flag dumps; flag MCP as feature-gated; use check/score gate vocabulary. - Correct to the v0.3.1 CLI surface (commands, flags, 0/1/2/3 exit codes).
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.
Why
The docs site (docs.agentis.tools) and
docs/messaging.mdwere repositioned around a single thesis — ctx is the local quality authority for AI-written code — but the README had fallen out of step. Its opening already carried the new positioning, yet the body was stale: organized as "Two Tools in One" (the old mental model), 830 lines of per-command flag dumps that now duplicate the docs site, and the killer workflow (ctx harness initwiring ctx into Claude Code) barely mentioned.What changed
Rewrote
README.mdas a lean front door (~285 lines) that quickly conveys what ctx is and why to care, and stays accurate to the v0.3.1 CLI.docs/messaging.md, unpacked into scannable Ground / Govern bullets with a concrete proof number (~8k tokens instead of 233k).ctx indexfirst; proof numbers woven in.ctx src/ | pbcopy) folded in as one capability under Ground. The 0/1/2/3 exit-code table as the integration API.map, PostToolUse→index+check, Stop→score) is now a headline, including the permission guardrails.check/score --fail-onvocabulary (no staleaudit --min-score/--incrementalshowcase); every doc link verified against a real page.Verification
src/cli.rs/src/exit.rs.docs/messaging.md(the source of truth).ctx checkpasses clean (docs-only change).