Docs Index

This is the canonical documentation home for bijux-atlas.

Use this page to choose the shortest honest route through the docs for your role. The numbered spine is written so readers can start with a high-level model, move into a first successful run, and then deepen into operations, architecture, reference facts, or contract promises only when they need them.

flowchart LR
    Start[Start here] --> Intro[01 Introduction]
    Intro --> GettingStarted[02 Getting Started]
    GettingStarted --> UserGuide[03 User Guide]
    UserGuide --> Operations[04 Operations]
    UserGuide --> Architecture[05 Architecture]
    UserGuide --> Reference[07 Reference]
    UserGuide --> Contracts[08 Contracts]
    Architecture --> Development[06 Development]

This reading map shows the intended progression. Readers who are new to Atlas should go left to right. Readers who already know the workflow can jump directly to the exact section they need.

Canonical Sections

• Introduction
• Getting Started
• User Guide
• Operations
• Architecture
• Development
• Reference
• Contracts

Choose a Path

• evaluating whether Atlas fits your problem: start with Introduction and What Atlas Is
• trying the product for the first time: follow Getting Started in order
• using Atlas day to day: begin in User Guide
• running Atlas in production or recovery scenarios: move to Operations
• changing the codebase or repository automation: read Architecture and Development
• checking exact facts, limits, or compatibility promises: use Reference and Contracts

Start Here

• new to Atlas: What Atlas Is
• installing and validating a local runtime: Install and Verify
• loading and serving your first dataset: Run Atlas Locally
• running Atlas in real environments: Operations
• checking exact surfaces and limits: Reference
• reviewing stable promises: Contracts

flowchart TD
    Reader[Reader question] --> Fit[What is Atlas?]
    Reader --> FirstRun[Can I run it locally?]
    Reader --> Operate[How do I run it safely?]
    Reader --> Change[How do I change it?]
    Reader --> Verify[What is guaranteed?]
    Fit --> Intro[Introduction]
    FirstRun --> GettingStarted[Getting Started]
    Operate --> Operations[Operations]
    Change --> Development[Development]
    Verify --> ReferenceAndContracts[Reference and Contracts]

This decision map is here so readers do not have to infer the right section from directory names alone. It turns the docs from a table of contents into a task-oriented entry point.

Current Review

• Server Workflows
• System Overview
• Testing and Evidence
• API Compatibility

Reading Rule

Behavior documented in 07-reference and 08-contracts is intended to be relied on more strongly.

If something appears only in examples, source code, or debug output, treat it as current behavior unless the contracts say otherwise.

That distinction matters because Atlas intentionally separates tutorial guidance, current implementation details, and explicit compatibility promises. This page points to all three, but it does not pretend they carry the same weight.

Maintenance Rule

Keep one canonical home per topic. When a page becomes redundant, fold its durable content into the existing docs spine instead of creating a parallel doc tree.

How to Read This Docs Set

• read section index pages first when you are entering a topic for the first time
• use reference pages when you need exact command names, keys, paths, or schemas
• use contract pages when a decision depends on stability promises or compatibility review
• treat generated outputs as evidence, not as the primary narrative explanation

Purpose

This page explains the Atlas material for bijux-atlas documentation and points readers to the canonical checked-in workflow or boundary for this topic.

Stability

This page is part of the canonical Atlas docs spine. Keep it aligned with the current repository behavior and adjacent contract pages.