469 lines
21 KiB
HTML
469 lines
21 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Introduction - VAPORA Platform Documentation</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="Comprehensive documentation for VAPORA, an intelligent development orchestration platform built entirely in Rust.">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<link rel="icon" href="favicon.svg">
|
|
<link rel="shortcut icon" href="favicon.png">
|
|
<link rel="stylesheet" href="css/variables.css">
|
|
<link rel="stylesheet" href="css/general.css">
|
|
<link rel="stylesheet" href="css/chrome.css">
|
|
<link rel="stylesheet" href="css/print.css" media="print">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" id="highlight-css" href="highlight.css">
|
|
<link rel="stylesheet" id="tomorrow-night-css" href="tomorrow-night.css">
|
|
<link rel="stylesheet" id="ayu-highlight-css" href="ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
|
|
|
|
<!-- Provide site root and default themes to javascript -->
|
|
<script>
|
|
const path_to_root = "";
|
|
const default_light_theme = "light";
|
|
const default_dark_theme = "dark";
|
|
</script>
|
|
<!-- Start loading toc.js asap -->
|
|
<script src="toc.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="mdbook-help-container">
|
|
<div id="mdbook-help-popup">
|
|
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
|
|
<div>
|
|
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
|
|
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
|
|
<p>Press <kbd>?</kbd> to show this help</p>
|
|
<p>Press <kbd>Esc</kbd> to hide this help</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="body-container">
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script>
|
|
try {
|
|
let theme = localStorage.getItem('mdbook-theme');
|
|
let sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script>
|
|
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
|
let theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
const html = document.documentElement;
|
|
html.classList.remove('light')
|
|
html.classList.add(theme);
|
|
html.classList.add("js");
|
|
</script>
|
|
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
let sidebar = null;
|
|
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
} else {
|
|
sidebar = 'hidden';
|
|
}
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<!-- populated by js -->
|
|
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
|
<noscript>
|
|
<iframe class="sidebar-iframe-outer" src="toc.html"></iframe>
|
|
</noscript>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
|
<div class="sidebar-resize-indicator"></div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky">
|
|
<div class="left-buttons">
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</label>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">VAPORA Platform Documentation</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
<a href="https://github.com/vapora-platform/vapora" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|
</a>
|
|
<a href="https://github.com/vapora-platform/vapora/edit/main/docs/src/../README.md" title="Suggest an edit" aria-label="Suggest an edit">
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script>
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="vapora-documentation"><a class="header" href="#vapora-documentation">VAPORA Documentation</a></h1>
|
|
<p>Complete user-facing documentation for VAPORA, an intelligent development orchestration platform.</p>
|
|
<h2 id="quick-navigation"><a class="header" href="#quick-navigation">Quick Navigation</a></h2>
|
|
<ul>
|
|
<li><strong><a href="getting-started.html">Getting Started</a></strong> — Start here</li>
|
|
<li><strong><a href="quickstart.html">Quickstart</a></strong> — Quick setup guide</li>
|
|
<li><strong><a href="setup/">Setup & Deployment</a></strong> — Installation, configuration, deployment</li>
|
|
<li><strong><a href="features/">Features</a></strong> — Capabilities and overview</li>
|
|
<li><strong><a href="architecture/">Architecture</a></strong> — Design, planning, and system overview</li>
|
|
<li><strong><a href="integrations/">Integrations</a></strong> — Integration guides and APIs</li>
|
|
<li><strong><a href="branding.html">Branding</a></strong> — Brand assets and guidelines</li>
|
|
<li><strong><a href="executive/">Executive Summary</a></strong> — Executive-level summaries</li>
|
|
</ul>
|
|
<h2 id="documentation-structure"><a class="header" href="#documentation-structure">Documentation Structure</a></h2>
|
|
<pre><code>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
|
|
</code></pre>
|
|
<h2 id="mdbook-integration"><a class="header" href="#mdbook-integration">mdBook Integration</a></h2>
|
|
<h3 id="overview"><a class="header" href="#overview">Overview</a></h3>
|
|
<p>This documentation project is fully integrated with <strong>mdBook</strong>, a command-line tool for building books from markdown. All markdown files in this directory are automatically indexed and linked through the mdBook system.</p>
|
|
<h3 id="directory-structure-for-mdbook"><a class="header" href="#directory-structure-for-mdbook">Directory Structure for mdBook</a></h3>
|
|
<pre><code>docs/
|
|
├── book.toml (mdBook configuration)
|
|
├── src/
|
|
│ ├── SUMMARY.md (table of contents - auto-generated)
|
|
│ ├── intro.md (landing page)
|
|
├── theme/ (custom styling)
|
|
│ ├── index.hbs (HTML template)
|
|
│ └── vapora-custom.css (custom CSS theme)
|
|
├── book/ (generated output - .gitignored)
|
|
│ └── index.html
|
|
├── .gitignore (excludes build artifacts)
|
|
│
|
|
├── README.md (this file)
|
|
├── getting-started.md (entry points)
|
|
├── quickstart.md
|
|
├── examples-guide.md (examples documentation)
|
|
├── tutorials/ (learning tutorials)
|
|
│
|
|
├── setup/ (installation & deployment)
|
|
├── features/ (product capabilities)
|
|
├── architecture/ (system design)
|
|
├── adrs/ (architecture decision records)
|
|
├── integrations/ (integration guides)
|
|
├── operations/ (runbooks & procedures)
|
|
└── disaster-recovery/ (recovery procedures)
|
|
</code></pre>
|
|
<h3 id="building-the-documentation"><a class="header" href="#building-the-documentation">Building the Documentation</a></h3>
|
|
<p><strong>Install mdBook (if not already installed):</strong></p>
|
|
<pre><code class="language-bash">cargo install mdbook
|
|
</code></pre>
|
|
<p><strong>Build the static site:</strong></p>
|
|
<pre><code class="language-bash">cd docs
|
|
mdbook build
|
|
</code></pre>
|
|
<p>Output will be in <code>docs/book/</code> directory.</p>
|
|
<p><strong>Serve locally for development:</strong></p>
|
|
<pre><code class="language-bash">cd docs
|
|
mdbook serve
|
|
</code></pre>
|
|
<p>Then open <code>http://localhost:3000</code> in your browser. Changes to markdown files will automatically rebuild.</p>
|
|
<h3 id="documentation-guidelines"><a class="header" href="#documentation-guidelines">Documentation Guidelines</a></h3>
|
|
<h4 id="file-naming"><a class="header" href="#file-naming">File Naming</a></h4>
|
|
<ul>
|
|
<li><strong>Root markdown</strong>: UPPERCASE (README.md, CHANGELOG.md)</li>
|
|
<li><strong>Content markdown</strong>: lowercase (getting-started.md, setup-guide.md)</li>
|
|
<li><strong>Multi-word files</strong>: kebab-case (setup-guide.md, disaster-recovery.md)</li>
|
|
</ul>
|
|
<h4 id="structure-requirements"><a class="header" href="#structure-requirements">Structure Requirements</a></h4>
|
|
<ul>
|
|
<li>Each subdirectory <strong>must</strong> have a README.md</li>
|
|
<li>Use relative paths for internal links: <code>[link](../other-file.md)</code></li>
|
|
<li>Add proper heading hierarchy: Start with h2 (##) in content files</li>
|
|
</ul>
|
|
<h4 id="markdown-compliance-markdownlint"><a class="header" href="#markdown-compliance-markdownlint">Markdown Compliance (markdownlint)</a></h4>
|
|
<ol>
|
|
<li>
|
|
<p><strong>Code Blocks (MD031, MD040)</strong></p>
|
|
<ul>
|
|
<li>Add blank line before and after fenced code blocks</li>
|
|
<li>Always specify language: ```bash, ```rust, ```toml</li>
|
|
<li>Use ```text for output/logs</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>Lists (MD032)</strong></p>
|
|
<ul>
|
|
<li>Add blank line before and after lists</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>Headings (MD022, MD001, MD026, MD024)</strong></p>
|
|
<ul>
|
|
<li>Add blank line before and after headings</li>
|
|
<li>Heading levels increment by one</li>
|
|
<li>No trailing punctuation</li>
|
|
<li>No duplicate heading names</li>
|
|
</ul>
|
|
</li>
|
|
</ol>
|
|
<h3 id="mdbook-configuration-booktoml"><a class="header" href="#mdbook-configuration-booktoml">mdBook Configuration (book.toml)</a></h3>
|
|
<p>Key settings:</p>
|
|
<pre><code class="language-toml">[book]
|
|
title = "VAPORA Platform Documentation"
|
|
src = "src" # Where mdBook reads SUMMARY.md
|
|
build-dir = "book" # Where output is generated
|
|
|
|
[output.html]
|
|
theme = "theme" # Path to custom theme
|
|
default-theme = "light"
|
|
edit-url-template = "https://github.com/.../edit/main/docs/{path}"
|
|
</code></pre>
|
|
<h3 id="custom-theme"><a class="header" href="#custom-theme">Custom Theme</a></h3>
|
|
<p><strong>Location</strong>: <code>docs/theme/</code></p>
|
|
<ul>
|
|
<li><code>index.hbs</code> — HTML template</li>
|
|
<li><code>vapora-custom.css</code> — Custom styling with VAPORA branding</li>
|
|
</ul>
|
|
<p>Features:</p>
|
|
<ul>
|
|
<li>Professional blue/violet color scheme</li>
|
|
<li>Responsive design (mobile-friendly)</li>
|
|
<li>Dark mode support</li>
|
|
<li>Custom syntax highlighting</li>
|
|
<li>Print-friendly styles</li>
|
|
</ul>
|
|
<h3 id="content-organization"><a class="header" href="#content-organization">Content Organization</a></h3>
|
|
<p>The <code>src/SUMMARY.md</code> file automatically indexes all documentation:</p>
|
|
<pre><code># VAPORA Documentation
|
|
|
|
## [Introduction](../README.md)
|
|
|
|
## Getting Started
|
|
- [Quick Start](../getting-started.md)
|
|
- [Quickstart Guide](../quickstart.md)
|
|
|
|
## Setup & Deployment
|
|
- [Setup Overview](../setup/README.md)
|
|
- [Setup Guide](../setup/setup-guide.md)
|
|
...
|
|
</code></pre>
|
|
<p><strong>No manual updates needed</strong> — SUMMARY.md structure remains constant as new docs are added to existing sections.</p>
|
|
<h3 id="deployment"><a class="header" href="#deployment">Deployment</a></h3>
|
|
<p><strong>GitHub Pages:</strong></p>
|
|
<pre><code class="language-bash"># Build the book
|
|
mdbook build
|
|
|
|
# Commit and push
|
|
git add docs/book/
|
|
git commit -m "chore: update documentation"
|
|
git push origin main
|
|
</code></pre>
|
|
<p>Configure GitHub repository settings:</p>
|
|
<ul>
|
|
<li>Source: <code>main</code> branch</li>
|
|
<li>Path: <code>docs/book/</code></li>
|
|
<li>Custom domain: docs.vapora.io (optional)</li>
|
|
</ul>
|
|
<p><strong>Docker (for CI/CD):</strong></p>
|
|
<pre><code class="language-dockerfile">FROM rust:latest
|
|
RUN cargo install mdbook
|
|
|
|
WORKDIR /docs
|
|
COPY . .
|
|
RUN mdbook build
|
|
|
|
# Output in /docs/book/
|
|
</code></pre>
|
|
<h3 id="troubleshooting"><a class="header" href="#troubleshooting">Troubleshooting</a></h3>
|
|
<div class="table-wrapper"><table><thead><tr><th>Issue</th><th>Solution</th></tr></thead><tbody>
|
|
<tr><td>Links broken in mdBook</td><td>Use relative paths: <code>../file.md</code> not <code>file.md</code></td></tr>
|
|
<tr><td>Theme not applying</td><td>Ensure <code>theme/</code> directory exists, run <code>mdbook build --no-create-missing</code></td></tr>
|
|
<tr><td>Search not working</td><td>Rebuild with <code>mdbook build</code></td></tr>
|
|
<tr><td>Build fails</td><td>Check for invalid TOML in <code>book.toml</code></td></tr>
|
|
</tbody></table>
|
|
</div>
|
|
<h3 id="quality-assurance"><a class="header" href="#quality-assurance">Quality Assurance</a></h3>
|
|
<p><strong>Before committing documentation:</strong></p>
|
|
<pre><code class="language-bash"># Lint markdown
|
|
markdownlint docs/**/*.md
|
|
|
|
# Build locally
|
|
cd docs && mdbook build
|
|
|
|
# Verify structure
|
|
cd docs && mdbook serve
|
|
# Open http://localhost:3000 and verify navigation
|
|
</code></pre>
|
|
<h3 id="cicd-integration"><a class="header" href="#cicd-integration">CI/CD Integration</a></h3>
|
|
<p>Add to <code>.github/workflows/docs.yml</code>:</p>
|
|
<pre><code class="language-yaml">name: Documentation
|
|
|
|
on:
|
|
push:
|
|
paths:
|
|
- 'docs/**'
|
|
branches: [main]
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- uses: peaceiris/actions-mdbook@v4
|
|
- run: cd docs && mdbook build
|
|
- uses: peaceiris/actions-gh-pages@v3
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
publish_dir: ./docs/book
|
|
</code></pre>
|
|
<hr />
|
|
<h2 id="content-standards"><a class="header" href="#content-standards">Content Standards</a></h2>
|
|
<p>Ensure all documents follow:</p>
|
|
<ul>
|
|
<li>Lowercase filenames (except README.md)</li>
|
|
<li>Kebab-case for multi-word files</li>
|
|
<li>Each subdirectory has README.md</li>
|
|
<li>Proper heading hierarchy</li>
|
|
<li>Clear, concise language</li>
|
|
<li>Code examples when applicable</li>
|
|
<li>Cross-references to related docs</li>
|
|
</ul>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
|
|
<a rel="next prefetch" href="../getting-started.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
|
|
<a rel="next prefetch" href="../getting-started.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
<script src="elasticlunr.min.js"></script>
|
|
<script src="mark.min.js"></script>
|
|
<script src="searcher.js"></script>
|
|
|
|
<script src="clipboard.min.js"></script>
|
|
<script src="highlight.js"></script>
|
|
<script src="book.js"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|