Last updated: 2026-02-15
This directory contains all project documentation. Start here to understand the project, then navigate to specific docs as needed.
- OVERVIEW.md — What is Running Red? High-level goals, users, and context.
- ARCHITECTURE.md — Technical architecture, data flow, components, deployment.
- CONTENT_MODEL.md — Data structures, content types, relationships.
- TECH_STACK.md — Technologies chosen and rationale.
- PRODUCT.md — Product requirements, user needs, pages, features.
- CONVENTIONS.md — Code style, file organization, naming, git workflow.
- IMPLEMENTATION.md — Phased implementation plan, roadmap.
- DECISIONS.md — Architecture Decision Records (why we chose X over Y).
- GLOSSARY.md — Terms, concepts, definitions.
- archive/ — Old documentation from the Payload CMS era (for reference only).
If you're a new AI agent or developer, read in this order:
- OVERVIEW.md — Understand what we're building
- PRODUCT.md — Understand user needs and requirements
- ARCHITECTURE.md — Understand how it works
- CONTENT_MODEL.md — Understand the data
- TECH_STACK.md — Understand the tools
- CONVENTIONS.md — Understand how to write code
- IMPLEMENTATION.md — Understand what to build next
If you need to make a decision, check:
- DECISIONS.md — See if it's already been decided
- TECH_STACK.md — Understand why we chose current tools
If you're unfamiliar with a term, check:
- GLOSSARY.md — Definitions for project-specific concepts
- Documentation drives implementation — Write docs first, code second.
- Be thorough, not clever — Clear and comprehensive beats elegant and terse.
- Don't skip things — If it's important, document it.
- Cross-reference liberally — Link to other docs when relevant.
- Keep it current — Update docs as the project evolves.
- When adding a feature: Update PRODUCT.md, CONTENT_MODEL.md (if data changes), IMPLEMENTATION.md
- When making architectural changes: Update ARCHITECTURE.md, DECISIONS.md
- When changing tech: Update TECH_STACK.md, DECISIONS.md
- When establishing patterns: Update CONVENTIONS.md
- When completing tasks: Update IMPLEMENTATION.md
Every significant change should result in updated documentation.