Documentation Map

9.3. Documentation Map

This page indexes the Atlas documentation. Start from the path that matches your role:

• New to Atlas (run it locally): Documentation home → Quick Start → Interactive Setup Wizard → Core Concepts → Tracks → Quick Start Troubleshooting.
• Building on Atlas (application developer): Service catalog → Configuration → Reusing Atlas as Infrastructure → Endpoint contract export → Backend plugin manifest.
• Operating or contributing: Operations → Architecture → Development → Contributing guide → Reference → Releasing → Security policy.

1. Documentation structure

1.1. Getting started

• Atlas documentation home — overview and entry point for the complete documentation set
• Quick Start — launch commands, common paths, and the first services to visit
• Interactive Setup Wizard — step-by-step guided configuration
• Quick Start Troubleshooting — common problems and fixes across the full stack, including recovery and reset
• Sudo Recovery — recovery after a launch or stop under sudo; linked from the start.sh and stop.sh error output
• Core concepts — SOURCE values, tracks, adaptive services, and routing
• Tracks — generated track-to-service matrix and selection behavior

1.2. Service documentation

• Service catalog — manifest-derived inventory of every service family, SOURCE variant, track, and dependency
• Service directory layout — folder ownership, virtual manifests, and service admission conventions

1.3. Provider and extension guides

• Docling Localhost Provider — run document extraction through a host-managed Docling process
• Parakeet Provider Overview — choose among supported speech-to-text provider backends
• Parakeet MLX Provider — Apple Silicon-native Parakeet setup and operation
• Parakeet whisper.cpp Provider — whisper.cpp-compatible speech-to-text operation
• TTS Provider Overview — select and configure the text-to-speech provider family
• TTS Localhost Provider — connect Atlas to a host-managed TTS process
• User Supabase Migrations — add downstream-owned SQL after Atlas migrations

1.4. Architecture diagrams

• Platform architecture — the top-level platform diagram
• Diagram catalog — generated index of the platform, lifecycle, data-flow, routing, observability, and security perspectives
• Diagram authoring — top-level diagram update workflow and per-service auto-generation chain

1.5. Configuration and operations

• Configuration overview — environment files, SOURCE overrides, and base-port behavior
• Operations overview — runtime commands, automation, validation, health, and managed-host lifecycle
• SOURCE Configuration — SOURCE-based deployment, including GPU variants
• Ports and Routes — canonical port offsets, direct URLs, and Kong routes
• Access and Credentials — which credential opens each surface, and what Supabase identity does and does not cover
• Iceberg advanced smoke test — opt-in validation for write, schema, snapshot, time-travel, and maintenance behavior
• Reusing Atlas as Infrastructure — decision guide for using Atlas as another project's infrastructure: which method, readiness, wiring and customization
• Using as a Submodule — deep-dive for the Git-submodule reuse method
• Releasing & version tags — semver tag convention for pinning a vendored Atlas
• Expected Startup Warnings — expected log lines and conditions that need operator action

1.6. Development and contribution

• Contributing guide — first contribution: setup, one safe Backend and bootstrapper test, the Docker and live-test boundary, the develop pull-request target, and the four required checks
• Development overview — service admission, consumer layout, required checks, and repository structure
• Adding a service runbook — six-decision walkthrough + the regen + lint chain
• Security policy — project posture, operational tiers, reachability triage, public-edge requirements, automated scanning gates, and the private-advisory reporting route
• docs/superpowers/ (repository only, not published) — point-in-time feature-track plans and specs
• docs/research/, docs/strategy/ and docs/maintenance/ (repository only, not published) — integration research, strategy notes and the external dependency contract ledger

2. Related documentation

• Reference index — generated SOURCE, environment, port, dependency, and manifest-field references
• Supply-chain license inventory — the license of every pinned image and downloaded model weight: notices, hosted-use, source-integration and redistribution terms, and open release review items
• ROADMAP — future development plans
• CHANGELOG — release history and completed features

3. Getting help

If you can't find what you're looking for:

1. Check Quick Start Troubleshooting
2. Search through the service-specific documentation
3. Open a GitHub issue if you need additional help (use the question label for questions)
4. For security-sensitive findings, follow the security policy instead of opening a public issue

4. Contributing to documentation

• Found a typo or error? Open a PR against develop; the contributing guide has the steps.
• Missing information? Open an issue.
• Before you submit documentation changes, run make docs-check from the repository root. It validates all documentation surfaces.