Document the 42 undocumented backend modules with READMEs
Labels / Complexity: docs · Medium Complexity — Medium
Problem
Only 2 of 44 src/ modules have a README.md (properties, transactions — verified by directory scan). Every other module — including auth, users, documents, search, blockchain, fraud, and content — has no in-module documentation of its responsibility, public endpoints, or invariants. New contributors (and the funded-program contributors this backlog targets) must reverse-engineer each module from code; the two documented modules show the expected shape.
Why this is architecturally hard
- Accuracy is the deliverable. A README that drifts from the code is worse than none; the docs must state real endpoints, guards, and data flows, verified against the code.
- Slicing is required. 42 modules is not one PR; the work should land in batches (e.g., per subsystem: auth/users, search/properties, transactions/documents) with the two existing READMEs as the template.
Acceptance criteria
- Every undocumented
src/ module gains a README covering its responsibility, public endpoints, and key invariants.
- Each README is accurate against the current code (guards, routes, and models it references exist).
- The batch lands in reviewable slices; the PR lists the modules covered.
Out of scope
API reference generation; rewriting the two existing READMEs.
Getting started
src/properties/README.md and src/transactions/README.md — the templates- Any undocumented module, e.g.
src/blockchain/
Commands: none required to verify; review the READMEs against the module code.
Good first files to read: src/properties/README.md, src/transactions/README.md.
Document the 42 undocumented backend modules with READMEs
Labels / Complexity: docs · Medium Complexity — Medium
Problem
Only 2 of 44
src/modules have aREADME.md(properties,transactions— verified by directory scan). Every other module — includingauth,users,documents,search,blockchain,fraud, andcontent— has no in-module documentation of its responsibility, public endpoints, or invariants. New contributors (and the funded-program contributors this backlog targets) must reverse-engineer each module from code; the two documented modules show the expected shape.Why this is architecturally hard
Acceptance criteria
src/module gains a README covering its responsibility, public endpoints, and key invariants.Out of scope
API reference generation; rewriting the two existing READMEs.
Getting started
src/properties/README.mdandsrc/transactions/README.md— the templatessrc/blockchain/Commands: none required to verify; review the READMEs against the module code.
Good first files to read:
src/properties/README.md,src/transactions/README.md.