DEX Documentation Hub¶
All documentation organized by topic and project.
Getting Started¶
New to DEX? Start here: 1. Main README - Project overview 2. Development Setup - Local environment setup 3. CI/CD Pipeline - Build, release, and publish workflow 4. Contributing - How to contribute
One-step Setup¶
Use this to install dependencies, set up pre-commit hooks, and verify the workspace in one quick flow.
📂 Documentation Structure¶
Framework (Common)¶
Core documentation for all DEX developers:
- Development Setup - Local development, workflow, testing
- Contributing Guidelines - Code style, commits, PR process
- Architecture - System design and technology stack
- Architecture Decision Records (ADRs) - Rationale for major technical decisions
- ADR-0001: Medallion Architecture
- CI/CD Pipeline - GitHub Actions automation
- Deployment Runbook - Release procedures
- Observability - Monitoring, logging, tracing
- SDLC - Software development lifecycle
- Release Notes - Version history
- Org + Domain Rollout - GitHub Organization and Cloudflare setup checklist
- Kubernetes Setup - Local K8s configuration
Projects¶
Project-specific documentation:
CareerDEX - CareerDEX Docs - Project overview and implementation status - Source Package - Package-level structure and architecture
Weather (Reference Implementation) - Weather Docs - Reference implementation guide - Source Package - Source package summary
Planning¶
- Project Roadmap (Canonical CSV) - Strategic milestones and status source of truth
- Project Roadmap (Derived JSON) - Machine-readable export generated from CSV
- GitHub Issues - Task tracking
🔍 Find What You Need¶
| Task | Link |
|---|---|
| Set up local development | Development Setup |
| Understand the architecture | Architecture |
| Deploy to production | Deployment Runbook |
| Set up monitoring | Observability |
| Contribute code | Contributing |
| Understand CI/CD | CI/CD Pipeline |
| Track work | SDLC |
| Configure org + domain | Org + Domain Rollout |
| Work on CareerDEX | CareerDEX Docs |
| Learn from reference | Weather Docs |
Documentation Structure¶
docs/
├── docs-hub.md (this file)
├── DEVELOPMENT.md
├── CONTRIBUTING.md
├── ARCHITECTURE.md
├── CI_CD.md
├── DEPLOY_RUNBOOK.md
├── OBSERVABILITY.md
├── SDLC.md
├── RELEASE_NOTES.md
├── LOCAL_K8S_SETUP.md
├── adr/ # Architecture decisions
│ ├── 0000-template.md
│ ├── 0001-medallion-architecture.md
│ └── ...
├── careerdex/ # CareerDEX project
│ └── index.md
├── weather/ # Weather reference
│ └── index.md
├── roadmap/ # Strategic planning
│ ├── project-roadmap.csv # Canonical source of truth
│ └── project-roadmap.json # Derived export
└── (other docs organized by topic)
Version: v0.3.6 | Updated: Feb 27, 2026