# Catalox documentation

Start at the [root README](../README.md).

## Essential

| Document | Description |
|----------|-------------|
| [overview.md](./overview.md) | Why Catalox exists |
| [app-content-backend.md](./app-content-backend.md) | Apps/agents as content API consumers |
| [USE-CASES.md](./USE-CASES.md) | Flows and fit vs misfit |
| [FAQ.md](./FAQ.md) | Common questions |
| [DEPLOYMENT.md](./DEPLOYMENT.md) | Embed, CLI, Docker, Authix |
| [onboarding-happy-path.md](./onboarding-happy-path.md) | Mongo → probe → seed → validate |
| [consumer-platform-guide.md](./consumer-platform-guide.md) | Native catalog provisioning for app teams |
| [environment.md](./environment.md) | Env vars |
| [mongo-persistence.md](./mongo-persistence.md) | **Primary persistence** |

## Platform roadmap (actionable)

| Doc | Use when |
|-----|----------|
| [catalox-v6/README.md](./catalox-v6/README.md) | Version map + assignment packs |
| [6.0.0/checklist.md](./catalox-v6/6.0.0/checklist.md) | **Next:** Mongo + R2 + publish |
| [6.1.0/checklist.md](./catalox-v6/6.1.0/checklist.md) | After 6.0.0: public Authix |

## By topic

### Data & storage
[mongo-persistence.md](./mongo-persistence.md) · [native-catalog-storage-and-api.md](./native-catalog-storage-and-api.md) · [catalog-format.md](./catalog-format.md) · [local-file-store.md](./local-file-store.md) · [smart-properties.md](./smart-properties.md) · [record-history.md](./record-history.md) · [backup.md](./backup.md) · [relation-catalogs.md](./relation-catalogs.md)

### Legacy Firestore / GCS (migration only)
[firestore-data-model.md](./firestore-data-model.md) · [firestore-gcs-export.md](./firestore-gcs-export.md) · [restore-firestore-backup.md](./restore-firestore-backup.md) · [6.0.0 transition](./catalox-v6/6.0.0/transition-from-5.10.md)

### Operations & CLI
[cli-items.md](./cli-items.md) · [cli-toolbox.md](./cli-toolbox.md) · [catalog-crud.md](./catalog-crud.md) · [cli-snapshot-export.md](./cli-snapshot-export.md) · [cli-validate-payload.md](./cli-validate-payload.md)

### Auth & identity
[authorization.md](./authorization.md) · [identity-model.md](./identity-model.md) · [outcomes.md](./outcomes.md)

### UI & presentation
[catalog-custom-ui.md](./catalog-custom-ui.md) · [catalog-list-render-map.md](./catalog-list-render-map.md) · [catalog-item-render-map.md](./catalog-item-render-map.md) · [design-objects.md](./design-objects.md) · [catalox-ui-contract.md](./catalox-ui-contract.md)

### Host integration
[host-canonical-source.md](./host-canonical-source.md) · [schema-packs.md](./schema-packs.md) · [pagenti-knowledge-usage.md](./pagenti-knowledge-usage.md)

### Open gaps
[catalox-blockers.md](./catalox-blockers.md) · [feature-requests/fr-catalox-graph-versioning-platform-feedback.md](./feature-requests/fr-catalox-graph-versioning-platform-feedback.md) · [feature-requests/catalox-exposure-scope-tasks.md](./feature-requests/catalox-exposure-scope-tasks.md)

## Package READMEs

| Package | README |
|---------|--------|
| Engine | [packages/core/engine/README.md](../packages/core/engine/README.md) |
| Contracts | [packages/core/contracts/README.md](../packages/core/contracts/README.md) |
| Storage | [packages/core/storage/README.md](../packages/core/storage/README.md) |
| API | [packages/http/api/README.md](../packages/http/api/README.md) |
| Client | [packages/http/client/README.md](../packages/http/client/README.md) |
| Authix bridge | [packages/http/authix-bridge/README.md](../packages/http/authix-bridge/README.md) |
| OpenAPI | [packages/http/openapi/README.md](../packages/http/openapi/README.md) |
| CLI | [packages/core/cli/README.md](../packages/core/cli/README.md) |
| Service | [packages/http/catalox-service/README.md](../packages/http/catalox-service/README.md) |
| Management | [packages/management/catalox-management/README.md](../packages/management/catalox-management/README.md) |