Skip to content

README's Repository Structure section is stale — mobile/, bridgelet-product-audit/, and .kilo/ are undocumented #398

Description

@phertyameen

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

  • Repository Structure section in README accurately lists every top-level folder with a one-line description
  • mobile/, bridgelet-product-audit/, and .kilo/ each have a documented purpose
  • A check (CI or documented review step) exists to catch future structure drift

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions