584 lines
23 KiB
HTML
584 lines
23 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Doc Lifecycle Integration - 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/../integrations/doc-lifecycle-integration.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="-doc-lifecycle-manager-integration"><a class="header" href="#-doc-lifecycle-manager-integration">📚 doc-lifecycle-manager Integration</a></h1>
|
||
|
|
<h2 id="dual-mode-agent-plugin--standalone-system"><a class="header" href="#dual-mode-agent-plugin--standalone-system">Dual-Mode: Agent Plugin + Standalone System</a></h2>
|
||
|
|
<p><strong>Version</strong>: 0.1.0
|
||
|
|
<strong>Status</strong>: Specification (VAPORA v1.0 Integration)
|
||
|
|
<strong>Purpose</strong>: Integration of doc-lifecycle-manager as both VAPORA component AND standalone tool</p>
|
||
|
|
<hr />
|
||
|
|
<h2 id="-objetivo"><a class="header" href="#-objetivo">🎯 Objetivo</a></h2>
|
||
|
|
<p><strong>doc-lifecycle-manager</strong> funciona de dos formas:</p>
|
||
|
|
<ol>
|
||
|
|
<li><strong>Como agente VAPORA</strong>: Documenter role usa doc-lifecycle internally</li>
|
||
|
|
<li><strong>Como sistema standalone</strong>: Proyectos sin VAPORA usan doc-lifecycle solo</li>
|
||
|
|
</ol>
|
||
|
|
<p>Permite adopción gradual: empezar con doc-lifecycle solo, migrar a VAPORA después.</p>
|
||
|
|
<hr />
|
||
|
|
<h2 id="-dual-mode-architecture"><a class="header" href="#-dual-mode-architecture">🔄 Dual-Mode Architecture</a></h2>
|
||
|
|
<h3 id="mode-1-standalone-sin-vapora"><a class="header" href="#mode-1-standalone-sin-vapora">Mode 1: Standalone (Sin VAPORA)</a></h3>
|
||
|
|
<pre><code>proyecto-simple/
|
||
|
|
├── docs/
|
||
|
|
│ ├── architecture/
|
||
|
|
│ ├── guides/
|
||
|
|
│ └── adr/
|
||
|
|
├── .doc-lifecycle-manager/
|
||
|
|
│ ├── config.toml
|
||
|
|
│ ├── templates/
|
||
|
|
│ └── metadata/
|
||
|
|
└── .github/workflows/
|
||
|
|
└── docs-update.yaml # Triggered on push
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Usage</strong>:</p>
|
||
|
|
<pre><code class="language-bash"># Manual
|
||
|
|
doc-lifecycle-manager classify docs/
|
||
|
|
doc-lifecycle-manager consolidate docs/
|
||
|
|
doc-lifecycle-manager index --for-rag
|
||
|
|
|
||
|
|
# Via CI/CD
|
||
|
|
.github/workflows/docs-update.yaml:
|
||
|
|
on: [push]
|
||
|
|
steps:
|
||
|
|
- run: doc-lifecycle-manager sync
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Capabilities</strong>:</p>
|
||
|
|
<ul>
|
||
|
|
<li>Classify docs by type</li>
|
||
|
|
<li>Consolidate duplicates</li>
|
||
|
|
<li>Manage lifecycle (draft → published → archived)</li>
|
||
|
|
<li>Generate RAG index</li>
|
||
|
|
<li>Build presentations (mdBook, Slidev)</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h3 id="mode-2-as-vapora-agent-with-vapora"><a class="header" href="#mode-2-as-vapora-agent-with-vapora">Mode 2: As VAPORA Agent (With VAPORA)</a></h3>
|
||
|
|
<pre><code>proyecto-vapora/
|
||
|
|
├── .vapora/
|
||
|
|
│ ├── agents/
|
||
|
|
│ │ └── documenter/
|
||
|
|
│ │ ├── config.toml
|
||
|
|
│ │ └── plugins/
|
||
|
|
│ │ └── doc-lifecycle-manager/ # Embedded
|
||
|
|
│ └── ...
|
||
|
|
├── docs/
|
||
|
|
└── .coder/
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Architecture</strong>:</p>
|
||
|
|
<pre><code>Documenter Agent (Role)
|
||
|
|
│
|
||
|
|
├─ Root Files Keeper
|
||
|
|
│ ├─ README.md
|
||
|
|
│ ├─ CHANGELOG.md
|
||
|
|
│ ├─ ROADMAP.md
|
||
|
|
│ └─ (auto-generated)
|
||
|
|
│
|
||
|
|
└─ doc-lifecycle-manager Plugin
|
||
|
|
├─ Classify documents
|
||
|
|
├─ Consolidate duplicates
|
||
|
|
├─ Manage ADRs (from sessions)
|
||
|
|
├─ Generate presentations
|
||
|
|
└─ Build RAG index
|
||
|
|
</code></pre>
|
||
|
|
<p><strong>Workflow</strong>:</p>
|
||
|
|
<pre><code>Task completed
|
||
|
|
↓
|
||
|
|
Orchestrator publishes: "task_completed" event
|
||
|
|
↓
|
||
|
|
Documenter Agent subscribes to: vapora.tasks.completed
|
||
|
|
↓
|
||
|
|
Documenter loads config:
|
||
|
|
├─ Root Files Keeper (built-in)
|
||
|
|
└─ doc-lifecycle-manager plugin
|
||
|
|
↓
|
||
|
|
Executes (in order):
|
||
|
|
1. Extract decisions from sessions → doc-lifecycle ADR classification
|
||
|
|
2. Update root files (README, CHANGELOG, ROADMAP)
|
||
|
|
3. Classify all docs in docs/
|
||
|
|
4. Consolidate duplicates
|
||
|
|
5. Generate RAG index
|
||
|
|
6. (Optional) Build mdBook + Slidev presentations
|
||
|
|
↓
|
||
|
|
Publishes: "docs_updated" event
|
||
|
|
</code></pre>
|
||
|
|
<hr />
|
||
|
|
<h2 id="-plugin-interface"><a class="header" href="#-plugin-interface">🔌 Plugin Interface</a></h2>
|
||
|
|
<h3 id="documenter-agent-loads-doc-lifecycle-manager"><a class="header" href="#documenter-agent-loads-doc-lifecycle-manager">Documenter Agent Loads doc-lifecycle-manager</a></h3>
|
||
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
||
|
|
</span><span class="boring">fn main() {
|
||
|
|
</span>pub struct DocumenterAgent {
|
||
|
|
pub root_files_keeper: RootFilesKeeper,
|
||
|
|
pub doc_lifecycle: DocLifecycleManager, // Plugin
|
||
|
|
}
|
||
|
|
|
||
|
|
impl DocumenterAgent {
|
||
|
|
pub async fn execute_task(
|
||
|
|
&mut self,
|
||
|
|
task: Task,
|
||
|
|
) -> anyhow::Result<()> {
|
||
|
|
// 1. Update root files (always)
|
||
|
|
self.root_files_keeper.sync_all(&task).await?;
|
||
|
|
|
||
|
|
// 2. Use doc-lifecycle for deep doc management (if configured)
|
||
|
|
if self.config.enable_doc_lifecycle {
|
||
|
|
self.doc_lifecycle.classify_docs("docs/").await?;
|
||
|
|
self.doc_lifecycle.consolidate_duplicates().await?;
|
||
|
|
self.doc_lifecycle.manage_lifecycle().await?;
|
||
|
|
|
||
|
|
// 3. Build presentations
|
||
|
|
if self.config.generate_presentations {
|
||
|
|
self.doc_lifecycle.generate_mdbook().await?;
|
||
|
|
self.doc_lifecycle.generate_slidev().await?;
|
||
|
|
}
|
||
|
|
|
||
|
|
// 4. Build RAG index (for search)
|
||
|
|
self.doc_lifecycle.build_rag_index().await?;
|
||
|
|
}
|
||
|
|
|
||
|
|
Ok(())
|
||
|
|
}
|
||
|
|
}
|
||
|
|
<span class="boring">}</span></code></pre></pre>
|
||
|
|
<hr />
|
||
|
|
<h2 id="-migration-standalone--vapora"><a class="header" href="#-migration-standalone--vapora">🚀 Migration: Standalone → VAPORA</a></h2>
|
||
|
|
<h3 id="step-1-run-standalone"><a class="header" href="#step-1-run-standalone">Step 1: Run Standalone</a></h3>
|
||
|
|
<pre><code class="language-bash">proyecto/
|
||
|
|
├── docs/
|
||
|
|
│ ├── architecture/
|
||
|
|
│ └── adr/
|
||
|
|
├── .doc-lifecycle-manager/
|
||
|
|
│ └── config.toml
|
||
|
|
└── .github/workflows/docs-update.yaml
|
||
|
|
|
||
|
|
# Usage: Manual or via CI/CD
|
||
|
|
doc-lifecycle-manager sync
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="step-2-install-vapora"><a class="header" href="#step-2-install-vapora">Step 2: Install VAPORA</a></h3>
|
||
|
|
<pre><code class="language-bash"># Initialize VAPORA
|
||
|
|
vapora init
|
||
|
|
|
||
|
|
# VAPORA auto-detects existing .doc-lifecycle-manager/
|
||
|
|
# and integrates it into Documenter agent
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="step-3-migrate-workflows"><a class="header" href="#step-3-migrate-workflows">Step 3: Migrate Workflows</a></h3>
|
||
|
|
<pre><code class="language-bash"># Before (in CI/CD):
|
||
|
|
- run: doc-lifecycle-manager sync
|
||
|
|
|
||
|
|
# After (in VAPORA):
|
||
|
|
# - Documenter agent runs automatically post-task
|
||
|
|
# - CLI still available:
|
||
|
|
vapora doc-lifecycle classify
|
||
|
|
vapora doc-lifecycle consolidate
|
||
|
|
vapora doc-lifecycle rag-index
|
||
|
|
</code></pre>
|
||
|
|
<hr />
|
||
|
|
<h2 id="-configuration"><a class="header" href="#-configuration">📋 Configuration</a></h2>
|
||
|
|
<h3 id="standalone-config"><a class="header" href="#standalone-config">Standalone Config</a></h3>
|
||
|
|
<pre><code class="language-toml"># .doc-lifecycle-manager/config.toml
|
||
|
|
|
||
|
|
[lifecycle]
|
||
|
|
doc_root = "docs/"
|
||
|
|
adr_path = "docs/adr/"
|
||
|
|
archive_days = 180
|
||
|
|
|
||
|
|
[classification]
|
||
|
|
enabled = true
|
||
|
|
auto_consolidate_duplicates = true
|
||
|
|
detect_orphaned_docs = true
|
||
|
|
|
||
|
|
[rag]
|
||
|
|
enabled = true
|
||
|
|
chunk_size = 500
|
||
|
|
overlap = 50
|
||
|
|
index_path = ".doc-lifecycle-manager/index.json"
|
||
|
|
|
||
|
|
[presentations]
|
||
|
|
generate_mdbook = true
|
||
|
|
generate_slidev = true
|
||
|
|
mdbook_out = "book/"
|
||
|
|
slidev_out = "slides/"
|
||
|
|
|
||
|
|
[lifecycle_rules]
|
||
|
|
[[rule]]
|
||
|
|
path_pattern = "docs/guides/*"
|
||
|
|
lifecycle = "guide"
|
||
|
|
retention_days = 0 # Never delete
|
||
|
|
|
||
|
|
[[rule]]
|
||
|
|
path_pattern = "docs/experimental/*"
|
||
|
|
lifecycle = "experimental"
|
||
|
|
retention_days = 30
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="vapora-integration-config"><a class="header" href="#vapora-integration-config">VAPORA Integration Config</a></h3>
|
||
|
|
<pre><code class="language-toml"># .vapora/.vapora.toml
|
||
|
|
|
||
|
|
[documenter]
|
||
|
|
# Embedded doc-lifecycle config
|
||
|
|
doc_lifecycle_enabled = true
|
||
|
|
doc_lifecycle_config = ".doc-lifecycle-manager/config.toml" # Reuse
|
||
|
|
|
||
|
|
[root_files]
|
||
|
|
auto_update = true
|
||
|
|
generate_changelog_from_git = true
|
||
|
|
generate_roadmap_from_tasks = true
|
||
|
|
</code></pre>
|
||
|
|
<hr />
|
||
|
|
<h2 id="-commands-both-modes"><a class="header" href="#-commands-both-modes">🎯 Commands (Both Modes)</a></h2>
|
||
|
|
<h3 id="standalone-mode"><a class="header" href="#standalone-mode">Standalone Mode</a></h3>
|
||
|
|
<pre><code class="language-bash"># Classify documents
|
||
|
|
doc-lifecycle-manager classify docs/
|
||
|
|
|
||
|
|
# Consolidate duplicates
|
||
|
|
doc-lifecycle-manager consolidate
|
||
|
|
|
||
|
|
# Manage lifecycle
|
||
|
|
doc-lifecycle-manager lifecycle prune --older-than 180d
|
||
|
|
|
||
|
|
# Build RAG index
|
||
|
|
doc-lifecycle-manager rag-index --output index.json
|
||
|
|
|
||
|
|
# Generate presentations
|
||
|
|
doc-lifecycle-manager mdbook build
|
||
|
|
doc-lifecycle-manager slidev build
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="vapora-integration"><a class="header" href="#vapora-integration">VAPORA Integration</a></h3>
|
||
|
|
<pre><code class="language-bash"># Via documenter agent (automatic post-task)
|
||
|
|
# Or manual:
|
||
|
|
vapora doc-lifecycle classify
|
||
|
|
vapora doc-lifecycle consolidate
|
||
|
|
vapora doc-lifecycle rag-index
|
||
|
|
|
||
|
|
# Root files (via Documenter)
|
||
|
|
vapora root-files sync
|
||
|
|
|
||
|
|
# Full documentation update
|
||
|
|
vapora document sync --all
|
||
|
|
</code></pre>
|
||
|
|
<hr />
|
||
|
|
<h2 id="-lifecycle-states-doc-lifecycle"><a class="header" href="#-lifecycle-states-doc-lifecycle">📊 Lifecycle States (doc-lifecycle)</a></h2>
|
||
|
|
<pre><code>Draft
|
||
|
|
├─ In-progress documentation
|
||
|
|
├─ Not indexed
|
||
|
|
└─ Not published
|
||
|
|
|
||
|
|
Published
|
||
|
|
├─ Ready for users
|
||
|
|
├─ Indexed for RAG
|
||
|
|
├─ Included in presentations
|
||
|
|
└─ Linked in README
|
||
|
|
|
||
|
|
Updated
|
||
|
|
├─ Recently modified
|
||
|
|
├─ Re-indexed for RAG
|
||
|
|
└─ Change log entry created
|
||
|
|
|
||
|
|
Archived
|
||
|
|
├─ Outdated
|
||
|
|
├─ Removed from presentations
|
||
|
|
├─ Indexed but marked deprecated
|
||
|
|
└─ Can be recovered
|
||
|
|
</code></pre>
|
||
|
|
<hr />
|
||
|
|
<h2 id="-rag-integration"><a class="header" href="#-rag-integration">🔐 RAG Integration</a></h2>
|
||
|
|
<h3 id="doc-lifecycle--rag-index"><a class="header" href="#doc-lifecycle--rag-index">doc-lifecycle → RAG Index</a></h3>
|
||
|
|
<pre><code class="language-json">{
|
||
|
|
"doc_id": "ADR-015-batch-workflow",
|
||
|
|
"title": "ADR-015: Batch Workflow System",
|
||
|
|
"doc_type": "adr",
|
||
|
|
"lifecycle_state": "published",
|
||
|
|
"created_date": "2025-11-09",
|
||
|
|
"last_updated": "2025-11-10",
|
||
|
|
"vector_embedding": [0.1, 0.2, ...], // 1536-dim
|
||
|
|
"content_preview": "Decision: Use Rust for batch orchestrator...",
|
||
|
|
"tags": ["orchestrator", "workflow", "architecture"],
|
||
|
|
"source_session": "sess-2025-11-09-143022",
|
||
|
|
"related_adr": ["ADR-010", "ADR-014"],
|
||
|
|
"search_keywords": ["batch", "workflow", "orchestrator"]
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="rag-search-via-vapora-agent-search"><a class="header" href="#rag-search-via-vapora-agent-search">RAG Search (Via VAPORA Agent Search)</a></h3>
|
||
|
|
<pre><code class="language-bash"># Search documentation
|
||
|
|
vapora search "batch workflow architecture"
|
||
|
|
|
||
|
|
# Results from doc-lifecycle RAG index:
|
||
|
|
# 1. ADR-015-batch-workflow.md (0.94 relevance)
|
||
|
|
# 2. batch-workflow-guide.md (0.87)
|
||
|
|
# 3. orchestrator-design.md (0.71)
|
||
|
|
</code></pre>
|
||
|
|
<hr />
|
||
|
|
<h2 id="-implementation-checklist"><a class="header" href="#-implementation-checklist">🎯 Implementation Checklist</a></h2>
|
||
|
|
<h3 id="standalone-components"><a class="header" href="#standalone-components">Standalone Components</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Document classifier (by type, domain, lifecycle)</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Duplicate detector & consolidator</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Lifecycle state management (Draft→Published→Archived)</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
RAG index builder (chunking, embeddings)</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
mdBook generator</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Slidev generator</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
CLI interface</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="vapora-integration-1"><a class="header" href="#vapora-integration-1">VAPORA Integration</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Documenter agent loads doc-lifecycle-manager</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Plugin interface (DocLifecycleManager trait)</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Event subscriptions (vapora.tasks.completed)</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Config reuse (.doc-lifecycle-manager/ detected)</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Seamless startup (no additional config)</li>
|
||
|
|
</ul>
|
||
|
|
<h3 id="migration-tools"><a class="header" href="#migration-tools">Migration Tools</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Detect existing .doc-lifecycle-manager/</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Auto-configure Documenter agent</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
Preserve existing RAG indexes</li>
|
||
|
|
<li><input disabled="" type="checkbox"/>
|
||
|
|
No data loss during migration</li>
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<h2 id="-success-metrics"><a class="header" href="#-success-metrics">📊 Success Metrics</a></h2>
|
||
|
|
<p>✅ Standalone doc-lifecycle works independently
|
||
|
|
✅ VAPORA auto-detects and loads doc-lifecycle
|
||
|
|
✅ Documenter agent uses both Root Files + doc-lifecycle
|
||
|
|
✅ Migration takes < 5 minutes
|
||
|
|
✅ No duplicate work (each tool owns its domain)
|
||
|
|
✅ RAG indexing automatic and current</p>
|
||
|
|
<hr />
|
||
|
|
<p><strong>Version</strong>: 0.1.0
|
||
|
|
<strong>Status</strong>: ✅ Integration Specification Complete
|
||
|
|
<strong>Purpose</strong>: Seamless doc-lifecycle-manager dual-mode integration with VAPORA</p>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
<a rel="prev" href="../../integrations/doc-lifecycle.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<a rel="next prefetch" href="../../integrations/rag-integration.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="prev" href="../../integrations/doc-lifecycle.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<a rel="next prefetch" href="../../integrations/rag-integration.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>
|