repo-orientation-doc

Writes a single-file orientation guide, conventionally named ARCHITECTURE.md, that gives new contributors a working mental model of an unfamiliar repository, covering the problem it solves, the path a typical request takes, a short scannable entry per top-level module with searchable symbol names, the hard rules about what each layer may and may not touch, and the conventions that span the whole tree. Use when someone asks for an architecture document or a codebase tour, wants newcomers oriented before their first change, or needs a map to decide where an edit belongs. Not for API references, READMEs, setup or contribution guides, per-function documentation, or detailed design records.

Version

v1.0.0

Size

13 KB

Updated

2026-10-06

Your client verifies the signature before reading. This explicit manual read is available on every plan. Free automatically loads five chosen skills; paid plans automatically load relevant skills across the library.