Skip to content

README architecture diagram is out of date #99

Description

@sophiecarreras

Summary

The architecture diagram in the README understates the current module layout across three directories. This creates a misleading mental model for contributors.

Evidence

Directory README claims Actual on disk
commands/ only commands/index.ts also publicBucketVisibility.ts, renameFile.ts
services/ 8 files 11 files (missing errorCode.ts, pathErrorSanitization.ts, sqlJsLoader.ts)
utils/ only utils/humanSize.ts 8 files total

Acceptance criteria

  • Architecture diagram updated to reflect current module layout
  • (Optional) Consider generating the diagram from disk rather than maintaining it manually

Filed by Quality Keeper drift-audit.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions