[G8-05] Document no performance guarantees yet #96

New issue

Open

opened 2026-05-28 01:16:12 +02:00 by codex · 0 comments

codex commented

2026-05-28 01:16:12 +02:00

Collaborator

Suggested executor: Gemini 3.5 Flash.

Wave: G8 — Performance and Scale Probes

Goal

Set user expectations around alpha performance.

Expected files

docs/adoption.md
docs/roadmap.md

Acceptance criteria

Docs state current alpha has no formal performance guarantee.
Docs still describe tool as fast/read-only without overclaiming.

Guardrails

One issue = one PR.
Add or update a behavior/golden test before changing behavior.
No runtime dependencies.
No new analyzer categories unless the issue explicitly says so.
Keep changes small; do not refactor src/analyze.ts broadly.

Verification

Run npm run build && npm test && git diff --check.

Suggested executor: Gemini 3.5 Flash. Wave: G8 — Performance and Scale Probes ## Goal Set user expectations around alpha performance. ## Expected files - `docs/adoption.md` - `docs/roadmap.md` ## Acceptance criteria - Docs state current alpha has no formal performance guarantee. - Docs still describe tool as fast/read-only without overclaiming. ## Guardrails - One issue = one PR. - Add or update a behavior/golden test before changing behavior. - No runtime dependencies. - No new analyzer categories unless the issue explicitly says so. - Keep changes small; do not refactor `src/analyze.ts` broadly. ## Verification - Run `npm run build && npm test && git diff --check`.