-
Notifications
You must be signed in to change notification settings - Fork 0
Repair README/docs parity with actual CLI surface #53
Copy link
Copy link
Closed
Labels
area/cliCLI command behaviorCLI command behaviorprio/P1High priorityHigh prioritytype/techdebtTechnical debt reductionTechnical debt reduction
Milestone
Description
Problem
README and CLI docs are outdated relative to current implementation, creating onboarding and trust friction.
Evidence
Examples:
- README documents
dex init/dex config validate, but command help does not expose these commands. - README still documents npm/node install paths despite Bun-first strategy.
- Option docs drift from current command behavior in multiple sections.
Scope
README.md- command help text in CLI where needed.
Acceptance Criteria
- All documented commands/options are runnable in current CLI.
- Bun-first guidance is authoritative and consistent.
- Add command-parity check section or script to prevent future drift.
Test Plan
- Manual smoke for documented examples.
- Link-check + command-parity checklist in PR.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
area/cliCLI command behaviorCLI command behaviorprio/P1High priorityHigh prioritytype/techdebtTechnical debt reductionTechnical debt reduction