Skip to content

Add a project-structure map to the README #342

Description

@Otaiki1

Context

README.md has a tree listing around line 339, but it is partial and mixes documentation files with
source directories. A newcomer cannot tell from it which directory owns the circuit, which owns the
prover, or where the browser code that generates proofs actually lives.

Every issue in this backlog names its files; the README should make those names meaningful.

Where to build it

  • README.md — the existing structure section around line 339.
  • docs/architecture.md — the detailed version links from here.

What to do

  • One table: directory, what it is, its language/toolchain, how to run its tests, and the label used for its issues (frontend, sdk, contracts, circuits).
  • Cover app/, packages/client/, contracts/, circuits/, scripts/, docs/, judges/, test-vectors/.
  • Fix the duplicated demo-video line at README lines 51–52 while you are in there — the same link line appears twice with different trailing links.
  • Link each row to that directory's own README.

Acceptance criteria

  • A newcomer can pick a directory to work in from the README alone.
  • The duplicate line at lines 51–52 is gone.

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions