Project Docs

Appearance

Documentation Index ​

Welcome to the Family Shapes documentation hub. This index groups the existing knowledge base so that contributors, agents, and stakeholders can quickly locate the resources they need.

Core Governance & Direction ​

  • AGENTS.md – Operational guardrails for database work and automation workflows (at repo root).
  • project-master.md – Product vision, scope, and living system map.
  • ROADMAP.md – Upcoming priorities, grouped by horizon and theme (at repo root).
  • CHANGELOG.md – Notable changes captured per release/iteration (at repo root).

Projects (planning & tracking) ​

  • Use DOCS/PROJECTS/ to create and track project planning docs.
  • Number every project and use that number as the filename prefix: NNNN_slug.md.
  • Store docs by status:
    • DOCS/PROJECTS/active/ – in progress
    • DOCS/PROJECTS/completed/ – delivered
    • DOCS/PROJECTS/backlog/ – prioritized but not started
    • DOCS/PROJECTS/stale/ – deprecated/paused
  • See DOCS/PROJECTS/README.md for the full scheme and rules.

Product & Feature Guides ​

  • Feature overviews live in DOCS/features/.
  • Getting started lives in DOCS/getting-started/.

Engineering Guides and Summaries ​

  • All engineering write-ups (frontend, connections, performance, fixes, testing, etc.) live in DOCS/development/ and are flat (no nested subfolders).

Database ​

All database docs are consolidated under DOCS/database/:

  • Start with DOCS/database/README.md for migrations, RLS, patterns, and checklists.
  • Architecture analyses and database plans live alongside it in the same folder.

Historical ​

Past fixes and iteration summaries live in DOCS/historical/ to keep the main docs concise while preserving useful context.

Tip: When you add a new document, update this index and relevant governance files (project-master.md, ROADMAP.md, CHANGELOG.md) to keep the knowledge base fresh.

How to Use This Documentation ​

  1. Start with project-master.md for high-level context.
  2. Review the ROADMAP.md to understand upcoming priorities.
  3. Use the CHANGELOG.md to record notable updates. Use npm run changelog:interactive or npm run changelog:add.
  4. For project planning, create a numbered doc under DOCS/PROJECTS/ at project kickoff.