Skip to content

INDEX.md

Latest commit

 

History

History
148 lines (101 loc) · 6.57 KB

INDEX.md

File metadata and controls

148 lines (101 loc) · 6.57 KB

Documentation Index

Last Updated: January 2026

Quick navigation to all documentation. See .cursor/README.md for priority rules.

Start Here

Doc Purpose
CLAUDE.md AI assistant entry point (navigation hub)
README.md Human-friendly intro, installation
rules.yaml Auto-injecting checklists
.cursor/README.md Documentation constitution & priority order

By Folder

Decisions (decisions/)

ADR Decision
ADR-001-tech-stack.md NestJS + Next.js stack

Architecture (architecture/)

File Contents
system-overview.md Tech stack, monorepo, packages, services

Reference (reference/)

File Contents
conventions.md Code style, naming, git workflow
security.md Validation, security requirements

Frameworks (frameworks/)

File Contents
nestjs.md DTOs, controllers, services, Swagger
nextjs.md RSC patterns, App Router

Roadmap (roadmap/)

File Contents
README.md Project milestones, future plans

Workflows (workflows/)

File Contents
integration-checklist.md External system integration checklist

By Task Type

Creating a New Feature

  1. Check ADRs: decisions/ - Don't re-litigate old decisions
  2. Read: system-overview.md - Understand data flow
  3. Read: nestjs.md - DTO patterns, Swagger
  4. Reference: conventions.md - Naming, code style

Adding API Endpoints

  1. Read: nestjs.md - Controller patterns
  2. Check: rules.yaml - Checklist auto-injects
  3. Reference: security.md - Validation requirements

Adding Frontend Pages

  1. Read: nextjs.md - RSC patterns
  2. Check: rules.yaml - Checklist auto-injects
  3. Reference: conventions.md - Naming conventions

Adding a Shared Package

  1. Read: system-overview.md - When & how
  2. Create packages/[name]/ with package.json, tsconfig.json
  3. Update root package.json workspaces if needed
  4. Add path aliases to consuming apps

Adding an External Service

  1. Read: system-overview.md - When & how
  2. Create services/[name]/ with Dockerfile
  3. Add to docker-compose.yml
  4. Create NestJS client service

Integrating External Systems

  1. Read: integration-checklist.md - Full checklist
  2. Understand wire format before coding
  3. Implement bidirectional conversion
  4. Test with actual system, not just TypeScript

Quick Search

Keyword Go To
DTO, validation nestjs.md
Swagger, API nestjs.md
Server Components nextjs.md
security, input security.md
git, commit conventions.md
package, shared system-overview.md
service, Python system-overview.md
Rust, microservice system-overview.md
integration, API integration-checklist.md
Redis, database integration-checklist.md

Auto-Injection

File: rules.yaml

Checklists auto-inject based on file patterns:

Pattern Checklist
**/*.controller.ts DTOs, Swagger, validation
**/*.service.ts logging, error handling
apps/web/**/*.tsx Server Components, TypeScript

Maintenance

When updating documentation:

  1. Update "Last Updated" date in file header
  2. Single source of truth: Update ONE file per topic
  3. Cross-reference: Link to other files, don't duplicate
  4. Priority order: decisions/ > architecture/ > reference/ > frameworks/ > roadmap/

Last Updated: January 2026