Skip to content

Latest commit

 

History

History

docs

README.md

Running Red Documentation

Last updated: 2026-02-15

This directory contains all project documentation. Start here to understand the project, then navigate to specific docs as needed.


📖 Documentation Index

Start Here

  • OVERVIEW.md — What is Running Red? High-level goals, users, and context.

System Design

Product Requirements

  • PRODUCT.md — Product requirements, user needs, pages, features.

Development

Reference

  • DECISIONS.md — Architecture Decision Records (why we chose X over Y).
  • GLOSSARY.md — Terms, concepts, definitions.

Archive

  • archive/ — Old documentation from the Payload CMS era (for reference only).

🗺️ Navigation Guide

If you're a new AI agent or developer, read in this order:

  1. OVERVIEW.md — Understand what we're building
  2. PRODUCT.md — Understand user needs and requirements
  3. ARCHITECTURE.md — Understand how it works
  4. CONTENT_MODEL.md — Understand the data
  5. TECH_STACK.md — Understand the tools
  6. CONVENTIONS.md — Understand how to write code
  7. 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

🎯 Design Principles

  1. Documentation drives implementation — Write docs first, code second.
  2. Be thorough, not clever — Clear and comprehensive beats elegant and terse.
  3. Don't skip things — If it's important, document it.
  4. Cross-reference liberally — Link to other docs when relevant.
  5. Keep it current — Update docs as the project evolves.

📝 How to Update These Docs

  • 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.