Technical docs for @stainless-code/codemap. Quick start: ../README.md.
| File | Topic |
|---|---|
| architecture.md | Schema, layering, CLI, API, User config (Zod), parsers, Key Files |
| agents.md | codemap agents init, --interactive, .gitignore / .codemap.*, IDE wiring (Cursor, Copilot, Windsurf, …), templates/agents |
| benchmark.md | Indexing another project · Benchmark script · fixtures/minimal/ |
| packaging.md | CHANGELOG.md / dist/ / templates/ on npm, engines, Node vs Bun, Releases (Changesets) |
| roadmap.md | Forward-looking backlog (not a src/ inventory) |
| why-codemap.md | Why index + SQL for agents (speed, tokens, accuracy) |
Cross-cutting: Runtime splits (SQLite, workers, globs, JSON config I/O) — packaging § Node vs Bun only (link it; don’t copy the table). User config shape/validation — architecture § User config only. Agent templates / agents init — agents.md only (don’t duplicate the IDE table elsewhere).
Conventions: One topic per file; relative links; avoid stale file/symbol counts in narrative docs (use codemap query / bun run dev query after indexing; methodology tables in benchmark.md are fine). This repo: bun run dev → bun src/index.ts; bun run build → tsdown → dist/; bun run clean / bun run check-updates — .github/CONTRIBUTING.md. Contributors: branch + PR into main (CI), bun run check, JSDoc on public API.