62 lines
2.0 KiB
Markdown
62 lines
2.0 KiB
Markdown
|
|
# VAPORA Documentation
|
||
|
|
|
||
|
|
Complete user-facing documentation for VAPORA, an intelligent development orchestration platform.
|
||
|
|
|
||
|
|
## Quick Navigation
|
||
|
|
|
||
|
|
- **[Getting Started](getting-started.md)** — Start here
|
||
|
|
- **[Quickstart](quickstart.md)** — Quick setup guide
|
||
|
|
- **[Setup & Deployment](setup/)** — Installation, configuration, deployment
|
||
|
|
- **[Features](features/)** — Capabilities and overview
|
||
|
|
- **[Architecture](architecture/)** — Design, planning, and system overview
|
||
|
|
- **[Integrations](integrations/)** — Integration guides and APIs
|
||
|
|
- **[Branding](branding.md)** — Brand assets and guidelines
|
||
|
|
- **[Executive Summary](executive/)** — Executive-level summaries
|
||
|
|
|
||
|
|
## Documentation Structure
|
||
|
|
|
||
|
|
```
|
||
|
|
docs/
|
||
|
|
├── README.md (this file - directory index)
|
||
|
|
├── getting-started.md (entry point)
|
||
|
|
├── quickstart.md (quick setup)
|
||
|
|
├── branding.md (brand guidelines)
|
||
|
|
├── setup/ (installation & deployment)
|
||
|
|
│ ├── README.md
|
||
|
|
│ ├── setup-guide.md
|
||
|
|
│ ├── deployment.md
|
||
|
|
│ ├── tracking-setup.md
|
||
|
|
│ └── ...
|
||
|
|
├── features/ (product capabilities)
|
||
|
|
│ ├── README.md
|
||
|
|
│ └── overview.md
|
||
|
|
├── architecture/ (design & planning)
|
||
|
|
│ ├── README.md
|
||
|
|
│ ├── project-plan.md
|
||
|
|
│ ├── phase1-integration.md
|
||
|
|
│ ├── completion-report.md
|
||
|
|
│ └── ...
|
||
|
|
├── integrations/ (integration guides)
|
||
|
|
│ ├── README.md
|
||
|
|
│ ├── doc-lifecycle.md
|
||
|
|
│ └── ...
|
||
|
|
└── executive/ (executive summaries)
|
||
|
|
├── README.md
|
||
|
|
├── executive-summary.md
|
||
|
|
└── resumen-ejecutivo.md
|
||
|
|
```
|
||
|
|
|
||
|
|
## For mdBook
|
||
|
|
|
||
|
|
This documentation is compatible with mdBook. Generate the book with:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
mdbook build
|
||
|
|
mdbook serve
|
||
|
|
```
|
||
|
|
|
||
|
|
Ensure all documents follow:
|
||
|
|
- Lowercase filenames (except README.md)
|
||
|
|
- Kebab-case for multi-word files
|
||
|
|
- Each subdirectory has README.md
|