docs: contributor guide, architecture map, and per-provider docs#284
Merged
docs: contributor guide, architecture map, and per-provider docs#284
Conversation
Document the contributor onboarding path: - CONTRIBUTING.md: setup, npm scripts, coding conventions, PR process, the block-claude-coauthor enforcement, and the five providers without test coverage today (claude, gemini, goose, qwen, antigravity). - docs/architecture.md: 12-command CLI surface, parser pipeline, three cache layers, 14 optimize detectors, and the mac / gnome / build layouts with cited line numbers. - docs/providers/: one file per provider (17 providers plus the shared vscode-cline-parser helper). Each covers data path, storage format, caching, dedup key, quirks, and a "when fixing a bug here" checklist. Also fix two pre-existing documentation issues surfaced while writing the new docs: - RELEASING.md claimed GitHub Actions auto-publishes the CLI when a v* tag is pushed. There is no such workflow; CLI publishing is manual via npm publish. Updated the CLI section to reflect reality and kept the menubar (mac-v* tag) automation accurate. - .gitignore had CLAUDE.md unanchored, which on case-insensitive filesystems also matched docs/providers/claude.md. Anchored to /CLAUDE.md so the root-level memory file stays ignored without affecting subdirectory docs. All cited file paths, line numbers, function names, and test counts were verified against current code (41 test files, 558 tests passing).
2 tasks
iamtoruk
added a commit
that referenced
this pull request
May 10, 2026
…285) The provider table now points each row at its docs/providers/<name>.md file (added in #284) instead of repeating a one-line path that the per-provider doc covers in full. The Data Location column is dropped; the new Doc column links to the markdown that owns the path, storage format, dedup key, and known quirks. The trailing sentence is updated to reference the per-provider docs as the source of truth for data locations.
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
CONTRIBUTING.md,docs/architecture.md, and 19 files underdocs/providers/(one per provider plus an index and the shared cline-parser helper).RELEASING.md: the CLI section claimed GitHub Actions auto-publishes on av*tag. There is no such workflow; CLI publishing is manual vianpm publish. Menubar automation (mac-v*tag firingrelease-menubar.yml) was accurate and is unchanged.CLAUDE.mdline in.gitignoreto/CLAUDE.mdso it only ignores the root-level memory file, notdocs/providers/claude.mdon case-insensitive filesystems.What is in
docs/providers/One file per integration. Each follows the same template: data path, storage format, caching, dedup key, quirks, and a "when fixing a bug here" checklist. Covers the 12 eager and 5 lazy providers registered in
src/providers/index.tsplus the sharedvscode-cline-parserhelper.Verification
All cited file paths, line numbers, function names, and counts were checked against current
main:src/cli.ts).src/optimize.ts).npx vitest --run).CONTRIBUTING.mdas a known gap.Test plan
git diff main..docs/contributor-guide -- '.gitignore'shows only the single-character anchor change.npm teststill passes (no source files were touched).docs/providers/*.mdfiles against the correspondingsrc/providers/*.tsto confirm the cited line numbers still resolve to the right code.