provisioning/docs

Provisioning Platform Documentation\n\nComplete documentation for the Provisioning Platform infrastructure automation system built with Nushell,\nNickel, and Rust.\n\n## 📖 Browse Documentation\n\nAll documentation is directly readable as markdown files in Git/GitHub—mdBook is optional.\n\n- Table of Contents – Complete documentation index (188+ pages)\n- Browse src/ directory – All markdown files organized by topic\n\n---\n\n## 🚀 Quick Navigation\n\n### For Users & Operators\n\n- Getting Started – Installation, setup, and first deployment\n- Operations Guide – Deployment, monitoring, orchestrator management\n- Troubleshooting – Common issues and solutions\n- Security – Authentication, encryption, secrets management\n\n### For Developers & Architects\n\n- Architecture Overview – System design and integration patterns\n- Infrastructure Guide – CLI, configuration system, workspaces\n- Development Guide – Extensions, providers, taskservs, build system\n- API Reference – REST API, WebSocket, SDKs, integration examples\n\n### For Advanced Users\n\n- Deployment Guides – Multi-provider setup, customization, infrastructure examples\n- Integration Guides – Gitea, OCI, service mesh, secrets integration\n- Testing – Test environment setup and validation\n\n---\n\n## 📚 Documentation Structure\n\n{$detected_lang}\nprovisioning/docs/\n├── README.md # This file – navigation hub\n├── book.toml # mdBook configuration\n├── src/ # Source markdown files (version-controlled)\n│ ├── SUMMARY.md # Complete table of contents\n│ ├── getting-started/ # Installation and setup\n│ ├── architecture/ # System design and ADRs\n│ ├── infrastructure/ # CLI, configuration, workspaces\n│ ├── operations/ # Deployment, orchestrator, monitoring\n│ ├── development/ # Extensions, providers, build system\n│ ├── api-reference/ # APIs and SDKs\n│ ├── security/ # Authentication, secrets, encryption\n│ ├── integration/ # Third-party integrations\n│ ├── guides/ # How-to guides and examples\n│ ├── troubleshooting/ # Common issues\n│ └── ... # 12 other sections\n├── book/ # Generated HTML output (Git-ignored)\n└── examples/ # Example workspace configurations\n\n\n### Why src/ subdirectory\n\nThis is the standard mdBook convention:\n- Source (src/): Version-controlled markdown files, directly readable\n- Output (book/): Generated HTML/CSS/JS, Git-ignored (regenerated on build)\n\nThis separation allows the same source files to generate multiple output formats (HTML, PDF, EPUB) without\ncluttering the version-controlled repository.\n\n---\n\n## 🔨 Building HTML with mdBook\n\nIf you prefer a formatted HTML website with search, themes, and copy buttons, build with mdBook:\n\n### Prerequisites\n\nbash\ncargo install mdbook\n\n\n### Build & Serve\n\nbash\n# Navigate to docs directory\ncd provisioning/docs\n\n# Build HTML to book/ directory\nmdbook build\n\n# Serve locally at http://localhost:3000 (with live reload)\nmdbook serve\n\n\n### Output\n\nGenerated HTML is available in provisioning/docs/book/ after building.\n\nNote: mdBook is entirely optional. The markdown files in src/ work perfectly fine in any Git\nviewer or text editor.\n\n---\n\n## 📖 Reading Markdown Directly\n\nAll documentation is standard GitHub Flavored Markdown. You can:\n\n- GitHub/GitLab: Click provisioning/docs/src/ and browse directly\n- Local Git: Clone the repo and open any .md file in your editor\n- Text Search: Use grep or your editor's search to find topics across all markdown files\n- mdBook (optional): Build HTML for formatted reading with search and theming\n\n---\n\n## 🔗 Key Reference Pages\n\n| Document | Purpose |\n| ------------------------------------------------------------------------------ | --------------------------------- |\n| System Overview | High-level architecture |\n| Installation Guide | Step-by-step setup |\n| CLI Reference | Command reference |\n| Configuration System | Config management |\n| Security System | Authentication & encryption |\n| Orchestrator | Service orchestration |\n| Workspace Guide | Infrastructure workspaces |\n| ADRs | Architecture Decision Records |\n\n---\n\n## ❓ Questions\n\n- Getting started → Start with Installation Guide\n- Having issues → Check Troubleshooting\n- Looking for API docs → See API Reference\n- Want architecture details → Read Architecture Overview\n\nFor complete navigation, see Table of Contents.