Description
The repo has extensive feature docs (docs/infinite-scroll-ux.md, the ACTIVITY_TIMELINE_* and TYPOGRAPHY* markdown files, a CONTRIBUTING.md, and docs/INSTALLATION.md/QUICKSTART.md) but no top-level architecture overview and no API documentation — docs/README.md indexes the existing docs without either. New contributors must reverse-engineer the route-group structure, the Zustand stores, the wallet layer, and how the (currently unused) NEXT_PUBLIC_API_URL is meant to be consumed. This issue adds an ARCHITECTURE.md and an API integration guide.
Requirements and context
- Add
docs/ARCHITECTURE.md describing the App Router route groups ((marketing), (dashboard), (auth)), the state layer (lib/events-store.ts Zustand store, context/WalletContext.tsx), the wallet integration (hooks/useWallet.hook.ts, constants/wallet-kits.constant.ts), and the component organization (components/ui, components/events, components/disputes, components/navbar).
- Add
docs/API.md documenting the env config (lib/env.ts/lib/config.ts, especially NEXT_PUBLIC_API_URL and NEXT_PUBLIC_STELLAR_NETWORK), the expected events/transactions data shapes from types/ and lib/mock-data.ts, and where real API calls should be introduced.
- Link both from
docs/README.md so they are discoverable.
- Non-functional: every file/path referenced must exist (no invented modules); keep the doc style consistent with the existing
docs/ files; include a simple route/state diagram (ASCII or mermaid).
- Note clearly which integrations are still mocked today so the docs do not overstate functionality.
Acceptance criteria
Suggested execution
1. Fork the repo and create a branch — git checkout -b docs/architecture-and-api.
2. Implement changes — add docs/ARCHITECTURE.md and docs/API.md; update docs/README.md.
3. Write/extend tests — no unit tests apply to docs; instead verify the build still passes and links resolve. (This repo uses Jest + React Testing Library with pnpm for code; run the validate pipeline to ensure nothing else broke.)
4. Test and commit —
pnpm install
pnpm lint
pnpm build
Example commit message
docs: add ARCHITECTURE.md and API integration guide and link from docs index
Guidelines
- No coverage change is expected for docs; instead ensure 100% of referenced paths are accurate and verified against the repo.
- Keep diagrams and terminology consistent with existing docs; clearly flag mocked features.
- Timeframe: 96 hours.
Description
The repo has extensive feature docs (
docs/infinite-scroll-ux.md, theACTIVITY_TIMELINE_*andTYPOGRAPHY*markdown files, aCONTRIBUTING.md, anddocs/INSTALLATION.md/QUICKSTART.md) but no top-level architecture overview and no API documentation —docs/README.mdindexes the existing docs without either. New contributors must reverse-engineer the route-group structure, the Zustand stores, the wallet layer, and how the (currently unused)NEXT_PUBLIC_API_URLis meant to be consumed. This issue adds anARCHITECTURE.mdand an API integration guide.Requirements and context
docs/ARCHITECTURE.mddescribing the App Router route groups ((marketing),(dashboard),(auth)), the state layer (lib/events-store.tsZustand store,context/WalletContext.tsx), the wallet integration (hooks/useWallet.hook.ts,constants/wallet-kits.constant.ts), and the component organization (components/ui,components/events,components/disputes,components/navbar).docs/API.mddocumenting the env config (lib/env.ts/lib/config.ts, especiallyNEXT_PUBLIC_API_URLandNEXT_PUBLIC_STELLAR_NETWORK), the expected events/transactions data shapes fromtypes/andlib/mock-data.ts, and where real API calls should be introduced.docs/README.mdso they are discoverable.docs/files; include a simple route/state diagram (ASCII or mermaid).Acceptance criteria
docs/ARCHITECTURE.mdcovers route groups, state layer, wallet layer, and component organization with correct paths.docs/API.mddocuments env config and the events/transactions data shapes and the intended integration point.docs/README.md.Suggested execution
1. Fork the repo and create a branch —
git checkout -b docs/architecture-and-api.2. Implement changes — add
docs/ARCHITECTURE.mdanddocs/API.md; updatedocs/README.md.3. Write/extend tests — no unit tests apply to docs; instead verify the build still passes and links resolve. (This repo uses Jest + React Testing Library with pnpm for code; run the validate pipeline to ensure nothing else broke.)
4. Test and commit —
Example commit message
Guidelines