Skip to content

Documentation Index

Complete alphabetical and categorical index of all Constellation documentation.

📚 By Category

Getting Started

Architecture & Design

Development Guides

Styling & UI

Quality & Testing

Operations

Support & Maintenance

Contributing

🔍 By Role

New Developer

Start Here → Follow this path:

  1. 03-QUICK_START.md - 10 minutes
  2. 02-SETUP_GUIDE.md - 30 minutes
  3. 04-ARCHITECTURE.md - 1 hour
  4. 06-COMPONENTS.md - Components overview
  5. 07-HOOKS.md - Hooks overview
  6. 14-TESTING.md - How to test
  7. Start coding!

Full-Stack Developer

Key References: - 04-ARCHITECTURE.md - System design - 08-SERVICES.md - Backend integration - 06-COMPONENTS.md - Component patterns - 14-TESTING.md - Testing strategy

Frontend Specialist

Key References: - 06-COMPONENTS.md - Components - 07-HOOKS.md - Hooks - 17-STYLING.md - Styling - 14-TESTING.md - Testing

DevOps / DevSecOps

Key References: - 19-DEPLOYMENT.md - Deployment - 20-PERFORMANCE.md - Performance - 02-SETUP_GUIDE.md - Environment setup

Maintainer

Key References: - 01-PROJECT_OVERVIEW.md - Overview - 04-ARCHITECTURE.md - Architecture - 05-CODE_STYLE_GUIDE.md - Standards - 25-CONTRIBUTING.md - Contributing - 23-TROUBLESHOOTING.md - Issues

🎯 By Task

I need to...

Setup Development Environment

→ 02-SETUP_GUIDE.md

Understand the Project

→ 01-PROJECT_OVERVIEW.md

Learn the Basics (10 min)

→ 03-QUICK_START.md

Create a New Component

→ 06-COMPONENTS.md

Create a Custom Hook

→ 07-HOOKS.md

Make an API Call

→ 08-SERVICES.md

Manage State

→ 09-STATE_MANAGEMENT.md

Use the Rich Text Editor

→ 10-EDITOR.md

Style a Component

→ 17-STYLING.md

Write Tests

→ 14-TESTING.md

Deploy to Production

→ 19-DEPLOYMENT.md

Optimize Performance

→ 20-PERFORMANCE.md

Fix a Bug

→ 23-TROUBLESHOOTING.md

Answer a Question

→ 24-FAQ.md

Contribute Code

→ 25-CONTRIBUTING.md

📖 Quick Reference

File Organization

Location: /docs/ directory

Files: 20 comprehensive guides

Total Content: ~25,000+ lines

Code Examples: 100+

Diagrams: 50+

What's Covered

✅ Setup & Installation
✅ Architecture & Patterns
✅ Components & UI
✅ Hooks & State Management
✅ Services & API Integration
✅ Rich Text Editor
✅ Testing & Quality
✅ Styling & CSS
✅ Deployment & DevOps
✅ Performance Optimization
✅ Troubleshooting
✅ Contributing Guidelines

What's NOT Covered

❌ Backend development
❌ Database schema
❌ Infrastructure setup
❌ Team management
❌ Project management

(See backend documentation for those topics)

🔗 Cross-References

📊 Document Statistics

Document Pages Topics Examples
OVERVIEW 5 15 10
PROJECT_OVERVIEW 12 25 15
SETUP_GUIDE 18 30 20
QUICK_START 8 15 20
ARCHITECTURE 20 40 25
CODE_STYLE_GUIDE 22 50 30
COMPONENTS 18 35 25
HOOKS 15 30 20
SERVICES 16 30 25
STATE_MANAGEMENT 14 25 20
EDITOR 12 25 20
TESTING 20 40 30
STYLING 18 35 25
DEPLOYMENT 15 30 20
PERFORMANCE 12 25 15
TROUBLESHOOTING 14 40 10
FAQ 10 50 5
CONTRIBUTING 12 25 10

🎓 Learning Paths

Path 1: New Developer (1-2 weeks)

Day 1:  QUICK_START → SETUP_GUIDE
Day 2:  PROJECT_OVERVIEW → ARCHITECTURE
Day 3:  COMPONENTS → HOOKS → SERVICES
Day 4:  STATE_MANAGEMENT → TESTING
Day 5:  STYLING → CODE_STYLE_GUIDE
Week 2: Build features following patterns

Path 2: Experienced Developer (1-2 days)

Hour 1:  ARCHITECTURE → CODE_STYLE_GUIDE
Hour 2:  COMPONENTS → HOOKS → SERVICES
Hour 3:  TESTING → Start coding

Path 3: DevOps (1-2 days)

Hour 1:  PROJECT_OVERVIEW → SETUP_GUIDE
Hour 2:  DEPLOYMENT → PERFORMANCE
Hour 3:  TROUBLESHOOTING → Configure CI/CD

🔍 Search Tips

By Technology

  • React: COMPONENTS, HOOKS, STATE_MANAGEMENT
  • Next.js: ARCHITECTURE, DEPLOYMENT
  • TypeScript: CODE_STYLE_GUIDE, ARCHITECTURE
  • Tailwind CSS: STYLING
  • Plate.js: EDITOR
  • Vitest: TESTING
  • TypeScript: CODE_STYLE_GUIDE

By Topic

  • State: STATE_MANAGEMENT, ARCHITECTURE
  • Data Fetching: SERVICES, ARCHITECTURE
  • Testing: TESTING, COMPONENTS, HOOKS
  • Performance: PERFORMANCE, DEPLOYMENT
  • Deployment: DEPLOYMENT, TROUBLESHOOTING
  • Errors: TROUBLESHOOTING, FAQ

By Problem

  • Setup Issues: SETUP_GUIDE, TROUBLESHOOTING
  • Code Quality: CODE_STYLE_GUIDE, TESTING
  • Performance: PERFORMANCE, DEPLOYMENT
  • Bugs: TROUBLESHOOTING, FAQ
  • Testing: TESTING, TROUBLESHOOTING

📞 Getting Help

If You're Stuck

  1. Search this index: Use Ctrl+F
  2. Check FAQ: 24-FAQ.md
  3. Check Troubleshooting: 23-TROUBLESHOOTING.md
  4. Find exact topic: Search by role or task above
  5. Ask team: Slack, discussion, or issue

Report Issues

  1. Check 23-TROUBLESHOOTING.md
  2. Check 24-FAQ.md
  3. Search existing issues
  4. Create new issue with details

Suggest Improvements

  1. Check related doc sections
  2. Create PR with improvements
  3. Follow 25-CONTRIBUTING.md

🚀 Get Started Now

Option 1: I'm brand new

👉 Start with 03-QUICK_START.md

Option 2: I'm experienced

👉 Start with 04-ARCHITECTURE.md

Option 3: I need to fix something

👉 Check 23-TROUBLESHOOTING.md

Option 4: I have a question

👉 Check 24-FAQ.md

📝 Document Maintenance

Last Updated

January 2026

Version

1.0

Maintenance Schedule

  • Monthly: Check for outdated info
  • Quarterly: Add new patterns
  • Yearly: Major review

How to Help

  • Report inaccuracies
  • Suggest improvements
  • Add examples
  • Fix typos

Happy Learning! 🎉

Start with the document that matches your role, then explore related docs as needed.

Need something specific? Use the links above to jump directly to the right guide.