Repository navigation
docs: fix drift — file: prefix, --json documentation, spec index - #4
Merged
Merged
Conversation
- CLAUDE.md files documented the local plugin prefix as 'local:./path' but the code implements 'file:' (resolver.rs strips the file: prefix); also correct the symlink_local arg order in src/CLAUDE.md - Document the global --json flag in the README and add it to the CHANGELOG Unreleased section (shipped in PR #1 without doc updates) - Add the 2026-05-28 json-output spec to the docs/CLAUDE.md index Co-Authored-By: Claude Fable 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
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.
Summary
Fixes documentation that had drifted from the code:
local:→file:— the root,src/, andsrc/commands/CLAUDE.md files all documented the local plugin prefix aslocal:./path, but the code implementsfile:(resolver.rsstrips thefile:prefix; the README and ROADMAP already saidfile:). Anyone following the CLAUDE.md docs would use a prefix that doesn't work. Also corrects thesymlink_localargument order insrc/CLAUDE.mdto match the real signature.--jsondocumentation backfill — the global--jsonflag shipped without README or CHANGELOG updates, despite the repo's own "Before Every Commit" rule. Adds a JSON output section to the README (output shapes verified against the integration tests) and an entry under CHANGELOG[Unreleased].docs/CLAUDE.mdtable. (The 2026-06-02 git-install spec is still untracked in the working tree, so its row can be added when that file is committed.)Docs only — no code changes.
🤖 Generated with Claude Code