436 lines
20 KiB
HTML
436 lines
20 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Tracking Quickstart - 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/../setup/tracking-quickstart.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>
|
|
<hr />
|
|
<h2>title: Vapora Tracking System - Quick Start Guide
|
|
date: 2025-11-10
|
|
status: READY
|
|
type: tracking-quickstart</h2>
|
|
<h1 id="-vapora-tracking-system---quick-start-guide"><a class="header" href="#-vapora-tracking-system---quick-start-guide">🚀 Vapora Tracking System - Quick Start Guide</a></h1>
|
|
<p><strong>⏱️ Time to get running: 5-10 minutes</strong></p>
|
|
<p>This guide walks you through installing and getting started with the Vapora tracking system component in the simplest way possible.</p>
|
|
<p><strong>Note:</strong> This guide is for the tracking system only. For complete Vapora project setup, see <a href="./QUICKSTART.html"><code>QUICKSTART.md</code></a>.</p>
|
|
<hr />
|
|
<h2 id="-prerequisites"><a class="header" href="#-prerequisites">📋 Prerequisites</a></h2>
|
|
<p>You need:</p>
|
|
<ul>
|
|
<li>✅ Rust 1.70+ (install from https://rustup.rs)</li>
|
|
<li>✅ Cargo (comes with Rust)</li>
|
|
<li>✅ Git</li>
|
|
<li>✅ 500MB free disk space</li>
|
|
<li>✅ Bash or Zsh shell</li>
|
|
</ul>
|
|
<p><strong>Check if you have everything:</strong></p>
|
|
<pre><code class="language-bash">rustc --version # Should show Rust 1.70+
|
|
cargo --version # Should show Cargo 1.70+
|
|
which git # Should show /usr/bin/git or similar
|
|
</code></pre>
|
|
<hr />
|
|
<h2 id="-5-minute-quick-start"><a class="header" href="#-5-minute-quick-start">🎯 5-Minute Quick Start</a></h2>
|
|
<h3 id="step-1-build-the-tracking-system"><a class="header" href="#step-1-build-the-tracking-system">Step 1: Build the Tracking System</a></h3>
|
|
<pre><code class="language-bash"># Build the tracking crate
|
|
cargo build -p vapora-tracking
|
|
|
|
# Or with backend integration
|
|
cargo build -p vapora-backend
|
|
</code></pre>
|
|
<p><strong>Expected output:</strong></p>
|
|
<pre><code> Finished `dev` profile [unoptimized + debuginfo] target(s) in X.XXs
|
|
</code></pre>
|
|
<h3 id="step-3-run-tests"><a class="header" href="#step-3-run-tests">Step 3: Run Tests</a></h3>
|
|
<pre><code class="language-bash"># Verify everything works
|
|
cargo test -p vapora-tracking --lib
|
|
|
|
# Should show: test result: ok. 20 passed
|
|
</code></pre>
|
|
<h3 id="step-4-start-using-it"><a class="header" href="#step-4-start-using-it">Step 4: Start Using It</a></h3>
|
|
<p><strong>Option A: Using Slash Commands (Easiest)</strong></p>
|
|
<pre><code class="language-bash"># In Claude Code, use the commands:
|
|
/log-change "Fixed bug in parser" --impact backend --files 3
|
|
/add-todo "Refactor database" --priority H --estimate M
|
|
/track-status --project vapora --limit 10
|
|
</code></pre>
|
|
<p><strong>Option B: Using Scripts (Manual Sync)</strong></p>
|
|
<pre><code class="language-bash"># Start the tracking service
|
|
./scripts/start-tracking-service.nu --verbose
|
|
|
|
# In another terminal, sync projects (replace with your development directory)
|
|
./scripts/sync-tracking.nu --projects-dir ~ --verbose
|
|
|
|
# Check status
|
|
/track-status
|
|
</code></pre>
|
|
<p><strong>Option C: Using API (Integration)</strong></p>
|
|
<pre><code class="language-bash"># Query the API
|
|
curl http://localhost:3000/api/v1/tracking/summary
|
|
curl http://localhost:3000/api/v1/tracking/entries?limit=10
|
|
</code></pre>
|
|
<hr />
|
|
<h2 id="-verify-installation"><a class="header" href="#-verify-installation">✅ Verify Installation</a></h2>
|
|
<p>After building, verify everything works:</p>
|
|
<h3 id="test-1-build-success"><a class="header" href="#test-1-build-success">Test 1: Build Success</a></h3>
|
|
<pre><code class="language-bash">cargo build -p vapora-tracking 2>&1 | tail -3
|
|
# Should show: Finished `dev` profile [unoptimized + debuginfo]
|
|
</code></pre>
|
|
<h3 id="test-2-tests-pass"><a class="header" href="#test-2-tests-pass">Test 2: Tests Pass</a></h3>
|
|
<pre><code class="language-bash">cargo test -p vapora-tracking --lib 2>&1 | grep "test result"
|
|
# Should show: test result: ok. 20 passed; 0 failed
|
|
</code></pre>
|
|
<h3 id="test-3-clippy-clean"><a class="header" href="#test-3-clippy-clean">Test 3: Clippy Clean</a></h3>
|
|
<pre><code class="language-bash">cargo clippy -p vapora-tracking --lib 2>&1 | grep "warning:" | wc -l
|
|
# Should show: 1 (profile warning only, which is expected)
|
|
</code></pre>
|
|
<h3 id="test-4-commands-available"><a class="header" href="#test-4-commands-available">Test 4: Commands Available</a></h3>
|
|
<pre><code class="language-bash">ls ~/.claude/commands/ | grep -E "log-change|add-todo|track-status"
|
|
# Should show all 3 commands
|
|
</code></pre>
|
|
<h3 id="test-5-skill-available"><a class="header" href="#test-5-skill-available">Test 5: Skill Available</a></h3>
|
|
<pre><code class="language-bash">ls ~/.claude/skills/tracking.md
|
|
# Should show the file exists
|
|
</code></pre>
|
|
<p><strong>If all 5 tests pass: ✅ Installation Complete!</strong></p>
|
|
<hr />
|
|
<h2 id="-first-time-usage"><a class="header" href="#-first-time-usage">🎬 First Time Usage</a></h2>
|
|
<h3 id="scenario-1-log-your-first-change"><a class="header" href="#scenario-1-log-your-first-change">Scenario 1: Log Your First Change</a></h3>
|
|
<p><strong>Using Slash Command (Easiest):</strong></p>
|
|
<pre><code class="language-bash">/log-change "Implemented user authentication" \
|
|
--impact backend \
|
|
--files 5
|
|
</code></pre>
|
|
<p><strong>What happens:</strong></p>
|
|
<ol>
|
|
<li>✅ Change is logged to database</li>
|
|
<li>✅ Timestamp added automatically</li>
|
|
<li>✅ Can be queried with <code>/track-status</code></li>
|
|
</ol>
|
|
<h3 id="scenario-2-create-your-first-todo"><a class="header" href="#scenario-2-create-your-first-todo">Scenario 2: Create Your First TODO</a></h3>
|
|
<p><strong>Using Slash Command:</strong></p>
|
|
<pre><code class="language-bash">/add-todo "Review code changes" \
|
|
--priority H \
|
|
--estimate M \
|
|
--due 2025-11-15
|
|
</code></pre>
|
|
<p><strong>What happens:</strong></p>
|
|
<ol>
|
|
<li>✅ TODO created in database</li>
|
|
<li>✅ Can be tracked with <code>/track-status</code></li>
|
|
<li>✅ Shows up in exports</li>
|
|
</ol>
|
|
<h3 id="scenario-3-check-your-status"><a class="header" href="#scenario-3-check-your-status">Scenario 3: Check Your Status</a></h3>
|
|
<p><strong>Using Slash Command:</strong></p>
|
|
<pre><code class="language-bash">/track-status --limit 5
|
|
</code></pre>
|
|
<p><strong>Output:</strong></p>
|
|
<pre><code>✅ Summary
|
|
Total entries: 3
|
|
Changes: 1
|
|
TODOs: 2
|
|
|
|
🔄 Changes
|
|
[2025-11-10T14:30:00Z] - Implemented user authentication
|
|
Impact: backend | Breaking: no | Files: 5
|
|
|
|
📋 TODOs
|
|
[HIGH] Review code changes (Medium) - Due: 2025-11-15
|
|
[HIGH] Write documentation (Small) - Due: 2025-11-12
|
|
</code></pre>
|
|
<hr />
|
|
<h2 id="-next-steps-after-installation"><a class="header" href="#-next-steps-after-installation">📚 Next Steps After Installation</a></h2>
|
|
<h3 id="short-term-today"><a class="header" href="#short-term-today">Short Term (Today)</a></h3>
|
|
<ol>
|
|
<li>✅ Log 2-3 changes you've made</li>
|
|
<li>✅ Create 2-3 TODOs for upcoming work</li>
|
|
<li>✅ Run <code>/track-status</code> to see results</li>
|
|
</ol>
|
|
<h3 id="medium-term-this-week"><a class="header" href="#medium-term-this-week">Medium Term (This Week)</a></h3>
|
|
<ol>
|
|
<li>📝 Set up daily tracking in your workflow</li>
|
|
<li>🔄 Sync multiple projects with <code>sync-tracking.nu</code></li>
|
|
<li>📊 Export your tracking data with <code>export-tracking.nu</code></li>
|
|
</ol>
|
|
<h3 id="long-term-ongoing"><a class="header" href="#long-term-ongoing">Long Term (Ongoing)</a></h3>
|
|
<ol>
|
|
<li>📈 Monitor project progress via <code>/track-status</code></li>
|
|
<li>🎯 Use for sprint planning and retrospectives</li>
|
|
<li>📉 Generate reports from exported data</li>
|
|
<li>🔗 Integrate with other Vapora services</li>
|
|
</ol>
|
|
<hr />
|
|
<h2 id="-need-more-help"><a class="header" href="#-need-more-help">🆘 Need More Help?</a></h2>
|
|
<div class="table-wrapper"><table><thead><tr><th>Question</th><th>Answer Location</th></tr></thead><tbody>
|
|
<tr><td>How do I use the tracking system?</td><td><code>TRACKING_SYSTEM_STATUS.md</code> (How to use section)</td></tr>
|
|
<tr><td>What are all the features?</td><td><code>crates/vapora-tracking/README.md</code> (Features section)</td></tr>
|
|
<tr><td>How do I deploy it?</td><td><code>crates/vapora-tracking/INTEGRATION.md</code> (Deployment section)</td></tr>
|
|
<tr><td>How do I fix an issue?</td><td><code>SETUP_TRACKING.md</code> (Troubleshooting section)</td></tr>
|
|
<tr><td>What's the architecture?</td><td><code>TRACKING_DOCUMENTATION_INDEX.md</code></td></tr>
|
|
</tbody></table>
|
|
</div>
|
|
<hr />
|
|
<h2 id="-super-quick-reference"><a class="header" href="#-super-quick-reference">⚡ Super Quick Reference</a></h2>
|
|
<pre><code class="language-bash"># Build
|
|
cargo build -p vapora-tracking
|
|
|
|
# Test
|
|
cargo test -p vapora-tracking --lib
|
|
|
|
# Use commands
|
|
/log-change "Summary" --impact backend
|
|
/add-todo "Task" --priority H --estimate M
|
|
/track-status --limit 10
|
|
|
|
# Use scripts
|
|
./scripts/sync-tracking.nu --verbose
|
|
./scripts/export-tracking.nu json --output report
|
|
./scripts/start-tracking-service.nu
|
|
|
|
# Query API
|
|
curl http://localhost:3000/api/v1/tracking/summary
|
|
</code></pre>
|
|
<hr />
|
|
<h2 id="-installation-checklist"><a class="header" href="#-installation-checklist">✅ Installation Checklist</a></h2>
|
|
<ul>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Rust 1.75+ installed</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Vapora repo available</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
<code>cargo build -p vapora-tracking</code> succeeds</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
<code>cargo test -p vapora-tracking --lib</code> shows 20 passed</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Slash commands copied to <code>~/.claude/commands/</code></li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Skill copied to <code>~/.claude/skills/</code></li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
<code>/log-change</code> command works</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
<code>/track-status</code> shows results</li>
|
|
</ul>
|
|
<p><strong>All checked? ✅ You're ready to go!</strong></p>
|
|
<hr />
|
|
<p><strong>For complete Vapora project setup:</strong> See <a href="./QUICKSTART.html"><code>QUICKSTART.md</code></a></p>
|
|
<p><strong>For tracking system deep dive:</strong> See <a href="./SETUP_TRACKING.html"><code>SETUP_TRACKING.md</code></a></p>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../../setup/tracking-setup.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="../../setup/secretumvault-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="../../setup/tracking-setup.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="../../setup/secretumvault-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>
|