Skip to content

Commit 3ee24e1

Browse files
committed
Fix the stale docs/ index and add a docs/plans/ pointer
IMPLEMENTATION.md's File Structure section listed six of the nine docs/ files, missing TUI.md, TELEMETRY.md, and PERFTRACE.md. Separately, docs/plans/ holds design-decision write-ups (including the current authoritative source on live permission-system gaps) but wasn't mentioned anywhere in AGENTS.md's Reference table, so an agent following AGENTS.md's own "read /docs first" instruction had no way to discover it.
1 parent 92af306 commit 3ee24e1

2 files changed

Lines changed: 3 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,4 @@ Interchange is the standard library for this repo, consumed as published `@intx/
9090
- `docs/PLUGINS.md` — plugin manifest system and discovery
9191
- `docs/TELEMETRY.md` — what usage telemetry is collected and why
9292
- `docs/PERFTRACE.md` — local PerfTrace and opt-in OTEL export settings
93+
- `docs/plans/` — working notes and design decisions, not normative like the docs above; worth checking for known-issue write-ups before starting related work

docs/IMPLEMENTATION.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,8 @@ src/
137137
command-catalog.ts, model-catalog.ts, chrome-state.ts, palette.ts,
138138
provider-setup.ts Onboarding provider setup flow
139139
docs/
140-
PRODUCT.md, ARCHITECTURE.md, IMPLEMENTATION.md, HOOKS.md, MCP.md, PLUGINS.md
140+
PRODUCT.md, ARCHITECTURE.md, IMPLEMENTATION.md, TUI.md, HOOKS.md, MCP.md,
141+
PLUGINS.md, TELEMETRY.md, PERFTRACE.md
141142
```
142143

143144
### Auto Mode

0 commit comments

Comments
 (0)