-
Notifications
You must be signed in to change notification settings - Fork 150
Description
Issue: Outdated Documentation in README.md and docs/DEV.md
Summary
Parts of the documentation (README.md and docs/DEV.md) are outdated and do not match the current codebase, tooling, or scripts. This may cause confusion and setup issues for new contributors.
Problems
1. Outdated Tech Stack Information in README.md
README.md still references:
-
TypeScript 4
-
React 17
-
Vite 4
-
Jest
-
Cypress
But the actual repo uses:
-
TypeScript 5
-
React 18
-
Vite 6
-
Vitest (not Jest)
-
No Cypress configuration
This mismatch misleads contributors setting up or extending the project.
2. Incorrect Test Commands in DEV.md
DEV.md instructs users to run:
npm run test:unit
npm run test:e2e
However, these scripts do not exist in the current root package.json.
The real command is:
npm run test
This causes confusion and failed setup attempts.
3. README.md Still Mentions Jest & Cypress
The repo uses Vitest, not Jest.
No Cypress e2e testing setup exists.
These entries need removal or correction.
Consequences
-
New contributors may follow incorrect commands → setup failures
-
Docs describe tools that the repo no longer uses
-
Testing instructions do not work as written
-
Tech stack section does not reflect reality
-
Creates onboarding friction and unnecessary questions
Fixing this will improve clarity, reduce confusion, and keep the documentation aligned with the actual monorepo structure.
Expected Fix
-
Update documentation to match the current codebase:
-
Update tech stack details (TypeScript 5, React 18, Vite 6, Vitest)
-
Remove outdated references (Jest, Cypress)
-
Update test commands in DEV.md to correct ones
-
Clarify that project uses Vitest
-
Remove instructions for scripts that no longer exist
Files Affected
-
README.md -
docs/DEV.md