Skip to content

[Docs] frontend/README.md is stale - documents built features (Zustand, ui/ component library, Jest/Playwright tests, localized routes) as 'planned' and lists wrong scripts/structure #1245

Description

@grantfox-oss

Telegram (ask questions / claim the issue here first): https://t.me/+DOylgFv1jyJlNzM0

Why this matters

frontend/README.md describes the app as aspirational. It says State Management is React hooks + Context API (planned) though the app ships Zustand stores; Wallet Integration is Stellar Wallet Kit (planned) though package.json depends on @stellar/freighter-api; Button/Card/Modal/Input are listed under Planned Components though they exist in frontend/src/app/components/ui/; Testing is Planned though Jest, Playwright and frontend/e2e/ exist. Available Scripts omits test/test:e2e/typecheck/format/audit:a11y and claims npm run lint runs ESLint when package.json defines it as prettier --check. Project Structure lists a tailwind.config.ts that does not exist.

Acceptance criteria

  • Rewrite README sections (Tech Stack, State Management, Wallet Integration, Component Library, Testing, Routing, Available Scripts, Project Structure) to reflect the shipped implementation
  • List all real npm scripts and correct the lint description (prettier, not ESLint)
  • Remove the nonexistent tailwind.config.ts reference and document the Tailwind 4 / globals.css token setup
  • Replace the / and /404 Current Routes list with the real localized /[locale]/* routes

Files to touch

  • frontend/README.md
  • frontend/package.json
  • frontend/src/app/components/ui
  • frontend/src/app/globals.css

Out of scope

  • Backend README
  • Adding new features

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocsDocumentationdocumentationImprovements or additions to documentationfrontendIssues related to frontend development

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions