mirror of
https://github.com/0xrsydn/idx-cli.git
synced 2026-11-07 09:45:36 +00:00
docs: add idx-core / idx-mcp system design
Accepted design for extracting idx-core as the shared data layer, the agent-native CLI output contract, idx-mcp tools, packaging, and the parity gates (golden output tests plus live A/B check) that the refactor must pass before merging to main. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
parent
86c108f6eb
commit
535ef64a0c
2 changed files with 324 additions and 0 deletions
|
|
@ -22,6 +22,7 @@ Docs:
|
|||
- `docs/CONVENTIONS.md`: types, naming, testing, and git rules
|
||||
- `docs/OWNERSHIP_SYNC.md` / `docs/OWNERSHIP_PUBLISH.md`: snapshot consumer contract / maintainer publishing
|
||||
- `docs/SMOKE.md`: Nix checks, test layout, and the live drift check
|
||||
- `docs/DESIGN.md`: idx-core / idx-mcp design and parity gates
|
||||
- `ROADMAP.md`: open work
|
||||
|
||||
## Rules
|
||||
|
|
@ -33,6 +34,9 @@ Docs:
|
|||
5. Keep ownership queries (`releases`, `ticker`, `changes`, ...) working across
|
||||
every ingest path: XLSX, legacy PDF, archive ZIP/TXT, and snapshot sync.
|
||||
6. `ownership import --fetch-bing` is intentionally unsupported.
|
||||
7. Output parity is a contract: never edit golden files to make a change pass.
|
||||
After changing CLI behavior, run the live check and report its summary;
|
||||
report IDX `403`s explicitly rather than counting them as passes.
|
||||
|
||||
## Verify
|
||||
```bash
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue