diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..9da87fd --- /dev/null +++ b/docs/README.md @@ -0,0 +1,138 @@ +# Provisioning Platform Documentation + +Complete documentation for the Provisioning Platform infrastructure automation system built with Nushell, +Nickel, and Rust. + +## πŸ“– Browse Documentation + +All documentation is **directly readable** as markdown files in Git/GitHubβ€”mdBook is optional. + +- **[Table of Contents](src/SUMMARY.md)** – Complete documentation index (188+ pages) +- **[Browse src/ directory](src/)** – All markdown files organized by topic + +--- + +## πŸš€ Quick Navigation + +### For Users & Operators + +- **[Getting Started](src/getting-started/)** – Installation, setup, and first deployment +- **[Operations Guide](src/operations/)** – Deployment, monitoring, orchestrator management +- **[Troubleshooting](src/troubleshooting/troubleshooting-guide.md)** – Common issues and solutions +- **[Security](src/security/)** – Authentication, encryption, secrets management + +### For Developers & Architects + +- **[Architecture Overview](src/architecture/)** – System design and integration patterns +- **[Infrastructure Guide](src/infrastructure/)** – CLI, configuration system, workspaces +- **[Development Guide](src/development/)** – Extensions, providers, taskservs, build system +- **[API Reference](src/api-reference/)** – REST API, WebSocket, SDKs, integration examples + +### For Advanced Users + +- **[Deployment Guides](src/guides/)** – Multi-provider setup, customization, infrastructure examples +- **[Integration Guides](src/integration/)** – Gitea, OCI, service mesh, secrets integration +- **[Testing](src/testing/)** – Test environment setup and validation + +--- + +## πŸ“š Documentation Structure + +``` +provisioning/docs/ +β”œβ”€β”€ README.md # This file – navigation hub +β”œβ”€β”€ book.toml # mdBook configuration +β”œβ”€β”€ src/ # Source markdown files (version-controlled) +β”‚ β”œβ”€β”€ SUMMARY.md # Complete table of contents +β”‚ β”œβ”€β”€ getting-started/ # Installation and setup +β”‚ β”œβ”€β”€ architecture/ # System design and ADRs +β”‚ β”œβ”€β”€ infrastructure/ # CLI, configuration, workspaces +β”‚ β”œβ”€β”€ operations/ # Deployment, orchestrator, monitoring +β”‚ β”œβ”€β”€ development/ # Extensions, providers, build system +β”‚ β”œβ”€β”€ api-reference/ # APIs and SDKs +β”‚ β”œβ”€β”€ security/ # Authentication, secrets, encryption +β”‚ β”œβ”€β”€ integration/ # Third-party integrations +β”‚ β”œβ”€β”€ guides/ # How-to guides and examples +β”‚ β”œβ”€β”€ troubleshooting/ # Common issues +β”‚ └── ... # 12 other sections +β”œβ”€β”€ book/ # Generated HTML output (Git-ignored) +└── examples/ # Example workspace configurations +``` + +### Why `src/` subdirectory + +This is the **standard mdBook convention**: +- **Source (`src/`)**: Version-controlled markdown files, directly readable +- **Output (`book/`)**: Generated HTML/CSS/JS, Git-ignored (regenerated on build) + +This separation allows the same source files to generate multiple output formats (HTML, PDF, EPUB) without +cluttering the version-controlled repository. + +--- + +## πŸ”¨ Building HTML with mdBook + +If you prefer a formatted HTML website with search, themes, and copy buttons, build with mdBook: + +### Prerequisites + +```bash +cargo install mdbook +``` + +### Build & Serve + +```bash +# Navigate to docs directory +cd provisioning/docs + +# Build HTML to book/ directory +mdbook build + +# Serve locally at http://localhost:3000 (with live reload) +mdbook serve +``` + +### Output + +Generated HTML is available in `provisioning/docs/book/` after building. + +**Note**: mdBook is entirely optional. The markdown files in `src/` work perfectly fine in any Git +viewer or text editor. + +--- + +## πŸ“– Reading Markdown Directly + +All documentation is standard GitHub Flavored Markdown. You can: + +- **GitHub/GitLab**: Click `provisioning/docs/src/` and browse directly +- **Local Git**: Clone the repo and open any `.md` file in your editor +- **Text Search**: Use `grep` or your editor's search to find topics across all markdown files +- **mdBook (optional)**: Build HTML for formatted reading with search and theming + +--- + +## πŸ”— Key Reference Pages + +| Document | Purpose | +| ------------------------------------------------------------------------------ | --------------------------------- | +| [System Overview](src/architecture/system-overview.md) | High-level architecture | +| [Installation Guide](src/getting-started/installation-guide.md) | Step-by-step setup | +| [CLI Reference](src/infrastructure/cli-reference.md) | Command reference | +| [Configuration System](src/infrastructure/configuration-system.md) | Config management | +| [Security System](src/security/security-system.md) | Authentication & encryption | +| [Orchestrator](src/operations/orchestrator.md) | Service orchestration | +| [Workspace Guide](src/infrastructure/workspaces/workspace-guide.md) | Infrastructure workspaces | +| [ADRs](src/architecture/adr/) | Architecture Decision Records | + +--- + +## ❓ Questions + +- **Getting started** β†’ Start with [Installation Guide](src/getting-started/installation-guide.md) +- **Having issues** β†’ Check [Troubleshooting](src/troubleshooting/troubleshooting-guide.md) +- **Looking for API docs** β†’ See [API Reference](src/api-reference/) +- **Want architecture details** β†’ Read [Architecture Overview](src/architecture/architecture-overview.md) + +For complete navigation, see [Table of Contents](src/SUMMARY.md).