Skip to content

README.md's Directory layout section is stale — it omits context/, hooks/, components/dashboard/, and several lib/ files entirely #254

Description

@chonilius

README.md's "Directory layout" section shows:

src/
  app/                 App Router routes (one folder per route above)
  components/
    ui/                Button, Badge, StatCard — small reusable primitives
    layout/            Navbar, Footer
    bounty/            BountyCard
  lib/
    api.ts             fetch wrapper + mock-data fallback
    config.ts           env-driven API base URL, OAuth URL, Stellar network
    mock-data.ts        realistic sample bounties/milestones/profiles for demos
    utils.ts            cn(), currency/percent/date formatting
    wallet.ts            Freighter connect/sign helpers
  types/
    index.ts             shared domain types (Bounty, Milestone, ReputationProfile, ...)

This tree is missing entire directories that exist in the real repo and are core to its
architecture: src/context/ (AuthContext, ThemeContext, WalletContext — the app's entire
session/wallet/theme state management) and src/hooks/ (useCrossTabStorage, which
several of the "Architecture" section's own claims about cross-tab behavior depend on)
are not mentioned anywhere in this tree. components/dashboard/ (ActivityList,
DashboardShell — rendered on every dashboard route) is also missing from the
components/ listing, which only shows ui/, layout/, and bounty/.

Under lib/, the tree lists five files but the real src/lib/ directory has nine:
adapters.ts (the entire raw-backend-to-UI-shape translation layer), auth.ts (token
storage), env.ts (the build-time validation this same README's "Environment variables"
section describes at length), and markdown.ts are all absent from this diagram.

A new contributor using this section to orient themselves would not know these five
files/directories exist at all, despite them being referenced by name elsewhere in this
very README (e.g. env.ts is explicitly named in the "Environment variables" section
just below).

Suggested fix: regenerate this tree from the actual src/ layout, including
context/, hooks/, components/dashboard/, and the missing lib/ files.

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programarchitectureArchitecture/design issuedocumentationImprovements or additions to documentationhelp wantedExtra attention is neededvery hardVery difficult task, expert-level effort required

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions