Skip to content

LCO DMA - Documentation Index

Welcome to the LCO Data Management Application documentation. This index helps you find the right documentation for your needs.

New to the team? Start with onboarding.

Work through these in order (~2-3 hours of reading + setup).

# Step Page
1 Get the app running Getting Started
2 Condensed run/quality commands Quick Start
3 Understand the whole app in 10 min Architecture Primer
4 How we use Claude Code here Claude Code Guide
5 Which skill to use when Skills Matrix

Documentation by Role

New Developers

Start here to get up and running:

  1. Quick Start Guide - Set up your development environment in 10 minutes
  2. README.md - Comprehensive project overview and setup
  3. Frontend Developer Guide - Frontend-specific development guide
  4. Backend Quick Start - Backend-specific quick start

Frontend Developers

Backend Developers

DevOps / Infrastructure

Architects / Technical Leads

Documentation by Topic

Setup & Installation

Architecture & Design

Development Workflow

API Documentation

  • API Reference - Complete endpoint reference
  • OpenAPI Spec - OpenAPI YAML
  • Interactive Docs (when running): http://localhost:8000/api/docs

Database

Deployment

Feature Documentation

Specialized Topics

Documentation Files

Root Level

  • README.md - Main project documentation (comprehensive)
  • justfile - Centralized command runner for all dev workflows (just --list)

/docs/

/docs/frontend/

/docs/backend/

/docs/database/

Common Tasks Quick Reference

I want to...

Set up my development environment → Quick Start Guide

Understand the overall architecture → Technical Architecture

Learn how to make frontend changes → Frontend Developer Guide

Understand the API endpoints → API Reference

Deploy to Azure → Backend README

Add a new page to the frontend → README.md - Adding a New Page

Add a new API endpoint → README.md - Adding a New API Endpoint

Understand the database schema → Database Index - Complete database documentation

Run linting and tests → README.md - Development Workflow

Troubleshoot issues → README.md - Troubleshooting

External Resources

Design

Technologies

Documentation Standards

Markdown Conventions

  • Use # for top-level headings
  • Use ## for major sections
  • Use ### for subsections
  • Use code blocks with language specifiers: ```typescript
  • Use bold for emphasis on important terms
  • Use inline code for code references, file paths, commands

File Naming

  • Use UPPERCASE for major documentation files (README.md, ARCHITECTURE.md)
  • Use kebab-case for specific topic files (crew-builder-flow.md)
  • Use .md extension for all documentation files

Code Examples

  • Include language-specific examples where applicable
  • Show both request and response for API examples
  • Include error cases in examples
  • Keep examples realistic and relevant

Contributing to Documentation

When updating documentation:

  1. Keep it DRY: Link to existing docs rather than duplicating
  2. Update this index: Add new files to this index
  3. Follow conventions: Match existing formatting and style
  4. Test examples: Ensure code examples work
  5. Use clear headings: Make content scannable
  6. No fluff: Every sentence should provide value

Getting Help

If you can't find what you need:

  1. Search this index for keywords
  2. Check the main README.md
  3. Review the Quick Start Guide
  4. Consult the Architecture docs
  5. Contact the development team

Version Information

  • Documentation Version: 2.1 (January 2026)
  • Application Version: 2.0.0
  • Last Updated: 2026-01-19

This documentation covers the latest version of the LCO DMA application. For older versions, refer to git history.