# NaxOS Documentation (`naxos-docs`)

[![Documentation Validation](https://git.lholz.de/naxos/naxos-docs/actions/workflows/ci.yaml/badge.svg)](https://git.lholz.de/naxos/naxos-docs/actions)

Welcome to the comprehensive documentation repository for **NaxOS**, the declarative, appliance-like Network Attached Storage (NAS) operating system built on NixOS and OpenZFS.

## Table of Contents

### 1. Architecture & Internals
- [High-Level Architecture & Philosophy](docs/architecture/overview.md)
- [Declarative Backend & GitOps Engine](docs/architecture/declarative-backend.md)
- [OpenZFS Storage Engine & Pool Migration](docs/architecture/storage-engine.md)
- [Workload App Engine & Tri-Tier Runtimes](docs/architecture/app-engine.md)
- [CNCF Perses Native Observability](docs/architecture/perses-analytics.md)

### 2. User & Administrator Guides
- [Installation & Live ISO Guide](docs/guides/installation.md)
- [Migration Guide: Transitioning from `nixos-lukas` to NaxOS](docs/guides/migration-from-nixos-lukas.md)

### 3. Developer Manual
- [Management Daemon REST & WebSocket API Reference](docs/development/api-reference.md)
- [Contributing & Development Workflow](docs/development/contributing.md)

---

## Ecosystem Repositories (`naxos` Organization)

| Repository | Description |
| :--- | :--- |
| [`naxos-os`](https://git.lholz.de/naxos/naxos-os) | Core NixOS distribution, declarative modules, Flake, and ISO builder |
| [`naxos-api`](https://git.lholz.de/naxos/naxos-api) | Management Daemon, REST/WebSocket API, GitOps synchronization, ZFS engine |
| [`naxos-ui`](https://git.lholz.de/naxos/naxos-ui) | Modern web dashboard, embedded Perses metrics, pool manager, app store |
| [`naxos-docs`](https://git.lholz.de/naxos/naxos-docs) | System architecture, migration tutorials, developer guides, and API specs |