2026-01-14 03:09:18 +00:00
|
|
|
<p align="center">\n <img src="resources/provisioning_logo.svg" alt="Provisioning Logo" width="300"/>\n</p>\n<p align="center">\n <img src="resources/logo-text.svg" alt="Provisioning" width="500"/>\n</p>\n\n# Provisioning Platform Documentation\n\n**Last Updated**: 2025-01-02 (Phase 3.A Cleanup Complete)\n**Status**: ✅ Primary documentation source (145 files consolidated)\n\nWelcome to the comprehensive documentation for the Provisioning Platform - a modern, cloud-native infrastructure automation system built with Nushell,\nNickel, and Rust.\n\n> **Note**: Architecture Decision Records (ADRs) and design documentation are in `docs/`\n> directory. This location contains user-facing, operational, and product documentation.\n\n---\n\n## Quick Navigation\n\n### 🚀 Getting Started\n\n| Document | Description | Audience |\n| ---------- | ------------- | ---------- |\n| **[Installation Guide](getting-started/installation-guide.md)** | Install and configure the system | New Users |\n| **[Getting Started](getting-started/getting-started.md)** | First steps and basic concepts | New Users |\n| **[Quick Reference](getting-started/quickstart-cheatsheet.md)** | Command cheat sheet | All Users |\n| **[From Scratch Guide](guides/from-scratch.md)** | Complete deployment walkthrough | New Users |\n\n### 📚 User Guides\n\n| Document | Description |\n| ---------- | ------------- |\n| **[CLI Reference](infrastructure/cli-reference.md)** | Complete command reference |\n| **[Workspace Management](infrastructure/workspace-setup.md)** | Workspace creation and management |\n| **[Workspace Switching](infrastructure/workspace-switching-guide.md)** | Switch between workspaces |\n| **[Infrastructure Management](infrastructure/infrastructure-management.md)** | Server, taskserv, cluster operations |\n| **[Service Management](operations/service-management-guide.md)** | Platform service lifecycle management |\n| **[OCI Registry](integration/oci-registry-guide.md)** | OCI artifact management |\n| **[Gitea Integration](integration/gitea-integration-guide.md)** | Git workflow and collaboration |\n| **[CoreDNS Guide](operations/coredns-guide.md)** | DNS management |\n| **[Test Environments](testing/test-environment-usage.md)** | Containerized testing |\n| **[Extension Development](development/extension-development.md)** | Create custom extensions |\n\n### 🏗️ Architecture\n\n| Document | Description |\n| ---------- | ------------- |\n| **[System Overview](architecture/system-overview.md)** | High-level architecture |\n| **[Multi-Repo Architecture](architecture/multi-repo-architecture.md)** | Repository structure and OCI distribution |\n| **[Design Principles](architecture/design-principles.md)** | Architectural philosophy |\n| **[Integration Patterns](architecture/integration-patterns.md)** | System integration patterns |\n| **[Orchestrator Model](architecture/orchestrator-integration-model.md)** | Hybrid orchestration architecture |\n\n### 📋 Architecture Decision Records (ADRs)\n\n| ADR | Title | Status |\n| ----- | ------- | -------- |\n| **[ADR-001](architecture/adr/adr-001-project-structure.md)** | Project Structure Decision | Accepted |\n| **[ADR-002](architecture/adr/adr-002-distribution-strategy.md)** | Distribution Strategy | Accepted |\n| **[ADR-003](architecture/adr/adr-003-workspace-isolation.md)** | Workspace Isolation | Accepted |\n| **[ADR-004](architecture/adr/adr-004-hybrid-architecture.md)** | Hybrid Architecture | Accepted |\n| **[ADR-005](architecture/adr/adr-005-extension-framework.md)** | Extension Framework | Accepted |\n| **[ADR-006](architecture/adr/adr-006-provisioning-cli-refactoring.md)** | CLI Refactoring | Accepted |\n\n### 🔌 API Documentation\n\n| Document | Description |\n| ---------- | ------------- |\n| **[REST API](api-reference/rest-api.md)** | HTTP API endpoints |\n| **[WebSocket API](api-reference/websocket.md)** | Real-time event streams |\n| **[Extensions API](development/extensions.md)** | Extension integration APIs |\n| **[SDKs](api-reference/sdks.md)** | Client libraries |\n| **[Integration Examples
|
