Location
- README.md — Repository Structure section
- mobile/ (top-level folder, purpose undocumented)
- bridgelet-product-audit/ (top-level folder, purpose undocumented)
- .kilo/ (top-level folder, purpose undocumented)
Problem
The README's "Repository Structure" section describes this repo as
containing only frontend/ and docs/. The actual top-level file listing
also includes mobile/, bridgelet-product-audit/, and .kilo/, none of
which are mentioned anywhere in the README's architecture, quick start, or
repository structure sections.
Impact
This is more than a cosmetic doc gap: a contributor or auditor reading the
README to understand what this repo contains has no way to know these
folders exist or what they're for, which is a problem for a project
explicitly built as financial infrastructure where unexplained content in
a public repo invites reasonable questions about scope and intent. It also
suggests the README isn't being kept in sync with actual repo changes.
Fix
- Document each folder's purpose in the Repository Structure section:
what mobile/ is for (a planned native app? Currently unused
scaffolding?), what bridgelet-product-audit/ contains and why it's
public, and what .kilo/ configures.
- If any of these folders contain material that shouldn't be public (see
the related audit issues for .kilo/ and bridgelet-product-audit/),
resolve that before simply documenting them.
- Add a lightweight CI or pre-commit check that flags new top-level
directories not mentioned in the README, to prevent this drifting again.
Acceptance criteria
Location
Problem
The README's "Repository Structure" section describes this repo as
containing only
frontend/anddocs/. The actual top-level file listingalso includes
mobile/,bridgelet-product-audit/, and.kilo/, none ofwhich are mentioned anywhere in the README's architecture, quick start, or
repository structure sections.
Impact
This is more than a cosmetic doc gap: a contributor or auditor reading the
README to understand what this repo contains has no way to know these
folders exist or what they're for, which is a problem for a project
explicitly built as financial infrastructure where unexplained content in
a public repo invites reasonable questions about scope and intent. It also
suggests the README isn't being kept in sync with actual repo changes.
Fix
what
mobile/is for (a planned native app? Currently unusedscaffolding?), what
bridgelet-product-audit/contains and why it'spublic, and what
.kilo/configures.the related audit issues for
.kilo/andbridgelet-product-audit/),resolve that before simply documenting them.
directories not mentioned in the README, to prevent this drifting again.
Acceptance criteria