docs: expand AGENTS.md repo map (cli, skills-catalog, teams-catalog, skills/) (#9960)
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - `AGENTS.md` is the contributor guide every human and AI agent reads first, and its "Repo Map" (§3) is meant to be the authoritative one-line-per-package index of the codebase > - `pnpm-workspace.yaml` lists `cli` as a first-class workspace package, a direct sibling of `server` and `ui` (`packages: [..., server, ui, cli]`) > - The Repo Map documents `server/`, `ui/`, and every `packages/*` workspace package (db, shared, adapters, adapter-utils, plugins) but never mentions `cli/`, even though it's published as the `paperclipai` npm package (`cli/package.json` → `"name": "paperclipai"`, bin `paperclipai`) and is exercised directly from other parts of this same file's setup flow (e.g. `pnpm paperclipai auth bootstrap-ceo` in `doc/DEVELOPING.md`) > - This is exactly the class of drift a prior commit (e186449f9, "docs: update adapter list and repo map accuracy") fixed for the adapter packages — a new top-level workspace package landed without updating this list > - This PR adds the missing one-line `cli/` entry, in the same format as its neighbors > - The benefit: a contributor or agent skimming §3 to understand the codebase layout no longer gets an incomplete picture that omits an entire published package ## Linked Issues or Issue Description No existing issue covers this. Following the "no issue exists" path with a docs-drift description: - **What happened:** `AGENTS.md` §3 ("Repo Map") lists every top-level workspace package except `cli/`, even though `cli/` is declared as a workspace package in `pnpm-workspace.yaml` (`packages: [..., server, ui, cli]`) and ships as the published `paperclipai` CLI referenced elsewhere in the same doc set (`doc/DEVELOPING.md`'s `pnpm paperclipai auth bootstrap-ceo`). - **Expected:** The Repo Map lists all first-class workspace packages a contributor would need to know about, consistent with how `packages/adapters`, `packages/adapter-utils`, and `packages/plugins` were added ine186449f9when those packages were introduced. - **Repro:** Compare `pnpm-workspace.yaml`'s `packages:` list against `AGENTS.md` §3 — `cli` is present in the former, absent from the latter. - **Version/commit:** current `master` (`e1050c1a8` at time of writing). Related PRs checked (none touch this): - #9935 — open, mine, removes an unrelated leaked fork-specific section (§11) from this same file. No overlap — that PR only deletes content at the end of the file; this PR adds one line to §3. - Searched `gh pr list --state all --search "AGENTS.md in:title"` and a GraphQL body search for `AGENTS.md` — the other hits are all about a different concept (per-agent runtime instruction bundles/templates the product generates for AI agents it orchestrates), not this repo's own root contributor guide. ## What Changed - Added a one-line `cli/` entry to `AGENTS.md` §3 ("Repo Map"), describing it as the published `paperclipai` CLI package, in the same format as the existing `packages/*` entries. ## Verification - `git diff` shows a single-line addition, no other content touched. - Confirmed `cli` is a real top-level workspace package via `pnpm-workspace.yaml` (`packages: [..., server, ui, cli]`) and `cli/package.json` (`"name": "paperclipai"`, `bin: { paperclipai: "./dist/index.js" }`). - Confirmed the omission was real by diffing against `git log --follow -p -- AGENTS.md` (commite186449f9added the other `packages/*` entries but predates/doesn't cover `cli/`). - Checked PR #9935 (my own other open PR, touches the same file) — confirmed via `gh pr view 9935 --json files` that it only removes §11 content (0 additions, 42 deletions) and does not touch §3, so there's no merge conflict or overlapping scope between the two. - Docs-only, no code/schema/behavior change — no typecheck/test/build impact. ## Risks Low risk. Single-line documentation addition, no behavioral, schema, or API impact. ## Model Used Claude Sonnet 5 (claude-sonnet-5), via Claude Code CLI. Standard reasoning, no extended thinking mode. Used for repo recon (workspace-package cross-check, git history verification, duplicate-PR search) and to author this fix and PR description. All commits authored by the human contributor (Santhi Prakash); no AI co-authorship attribution on commits. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (`docs/add-cli-package-to-agents-md-repo-map`) and contains no internal Paperclip ticket id or instance-derived details - [ ] I have run tests locally and they pass — N/A, docs-only change (see Verification) - [ ] I have added or updated tests where applicable — N/A, docs-only - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [ ] All Paperclip CI gates are green — confirm after opening the PR - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups — confirm after opening the PR - [x] I will address all Greptile and reviewer comments before requesting merge
This commit is contained in:
parent
3f86508514
commit
1f7b71067f
|
|
@ -29,6 +29,10 @@ Before making changes, read in this order:
|
|||
- `packages/adapters/`: agent adapter implementations (Claude, Codex, Cursor, etc.)
|
||||
- `packages/adapter-utils/`: shared adapter utilities
|
||||
- `packages/plugins/`: plugin system packages
|
||||
- `packages/skills-catalog/`: app-shipped skills catalog (`@paperclipai/skills-catalog`)
|
||||
- `packages/teams-catalog/`: app-shipped teams catalog (`@paperclipai/teams-catalog`)
|
||||
- `cli/`: `paperclipai` CLI package (published bin, agent-facing commands)
|
||||
- `skills/`: Paperclip runtime/operational skills (not part of the app catalog)
|
||||
- `doc/`: operational and product docs
|
||||
|
||||
## 4. Dev Setup (Auto DB)
|
||||
|
|
|
|||
Loading…
Reference in New Issue