docs(docs): add the VS Code install example and strip history from the standalone docs - #11
Merged
Merged
Conversation
…e standalone docs The Agent Plugins 1.0 install path is verified in VS Code (Command Palette, "Chat: Install Plugin from Source", the repository slug), so the README now gives that walkthrough instead of a hedge about the spec leaving installation to clients. The standalone docs must read as-is: a README reader or a maintainer loading a dev skill has no access to the sessions that produced the rules. The dev skills cited MEM (the lead's memory), PR numbers, incident dates and this machine's paths; those are removed, the rules they backed stay, and every report shorthand the skills cite (KT-*, OBS-*, PH, CI, RI) is now a row of the AGENTS.md legend so each citation resolves inside the repository. Three cross-references to headings that no longer exist are repointed. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…elopment cycle Nothing in the repository claimed LightOn's endorsement, but nothing denied it either; a reader deciding where to file a colgrep bug needs the boundary stated at the top. The new section tells a human reader who does the work here and how a change reaches main, so the agent-run cycle is visible rather than implied by the commit history, and names the two conditions it depends on: a frontier model and a maintainer who reads every diff. Co-Authored-By: Claude Fable 5.1 <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
1 participant
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 Agent Plugins 1.0 install path is now verified in VS Code: Command Palette, Chat: Install Plugin from Source, enter
CrackingShells/colgrep-mcp. The README gives that walkthrough as the example instead of a hedge about the spec leaving installation to clients.The standalone docs must read as-is. A README reader or a maintainer loading a dev skill has no access to the sessions that produced the rules, so history, development state and chat context are stripped from every authored document except
CHANGELOG.md,__reports__/and__roadmap__/, which are records by nature.What changed
README.md: VS Code example under the Agent Plugins section; the Codex "not yet exercised end to end" caveat, the report pointers in Hooks and Development, and the "latest run" sentence are gone.dev/skills/*: everyMEM("lead memory") and "lead memory" citation removed, along with PR numbers, incident dates, per-cycle anecdotes and this machine's paths. The rules they backed stay, cited to their reports.AGENTS.md: the legend now definesKT-B/C/D/H,OBS-C/D/H,PH,CIandRI, so every id the skills cite resolves inside the repository (107 of 130 lines).CONTRIBUTING.md#allowed-types,§Branching,AGENTS.md §Conventions/§Traps) are repointed.drift-tests.mdgains rows fortest_packaging.pyandtest_hooks.py.Gates
uv run pytest: 306 passed, 1 skippedclaude plugin validate .and./dev: both passcz check --rev-range main..HEAD: successful🤖 Generated with Claude Code