Skip to content

Latest commit

 

History

History
15 lines (11 loc) · 2.76 KB

File metadata and controls

15 lines (11 loc) · 2.76 KB

Documentation

Organized by two axes: domain (what this document is about) and type (what shape it takes / what the reader is trying to do). A document always lives at the intersection of both. e.g. product-code/reference/ is a lookup table about the code, team-process/how-to/ is a step-by-step guide about how the team works.

Type →
Domain ↓
Concept How-to Reference Decisions Tutorials Runbooks
product-code Architecture overview 🚧 Code style 🚧, Environment variables 🚧 First decision 🚧 Getting started 🚧
operations CI/CD pipeline, Repository configuration Deployment 🚧
team-process Activate Git hooks Commit conventions & PR process
organizational Role charter 🚧 Tool inventory 🚧, Code owners Tooling choice 🚧

🚧 = template placeholder (todo_ prefix), no real content yet, see the note inside each file for what to fill in and how to rename it once done. ⧉ = lives outside docs/ at a fixed path, see below.

A few things intentionally live outside this grid, at fixed paths GitHub itself expects: README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, LICENSE, and .github/CODEOWNERS. Moving them would break the platform features tied to those paths (Security tab, community profile checklist, the PR-open banner), so unlike the rest of the grid, these stay canonical at their GitHub-required location, and the grid links to them rather than absorbing their content. CONTRIBUTING.md in particular is intentionally kept complete (commit conventions, bug/feature reporting, PR process included inline) rather than split into docs/team-process/, since GitHub surfaces it directly at the moment a contributor opens a PR or issue, splitting it would add a click at exactly the point someone needs the answer fastest.