Vapora/docs/tutorials/index.html

402 lines
18 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
<html lang="en" class="light sidebar-visible" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Tutorials - 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/../tutorials/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-tutorials"><a class="header" href="#vapora-tutorials">VAPORA Tutorials</a></h1>
<p>Step-by-step guides to learn VAPORA from basics to advanced workflows.</p>
<h2 id="learning-path"><a class="header" href="#learning-path">Learning Path</a></h2>
<p>Follow these tutorials in order to build comprehensive understanding:</p>
<h3 id="1-getting-started-15-min"><a class="header" href="#1-getting-started-15-min">1. Getting Started (15 min)</a></h3>
<ul>
<li>Build VAPORA from source</li>
<li>Start backend and frontend services</li>
<li>Run first agent</li>
<li>Verify complete stack is operational</li>
</ul>
<p><strong>Start here:</strong> <a href="01-getting-started.html">01-getting-started.md</a></p>
<h3 id="2-basic-agents-20-min"><a class="header" href="#2-basic-agents-20-min">2. Basic Agents (20 min)</a></h3>
<ul>
<li>Create an agent registry</li>
<li>Register agents with capabilities</li>
<li>Execute simple agent tasks</li>
<li>Understanding agent metadata</li>
</ul>
<p><strong>Prerequisites:</strong> Complete Getting Started</p>
<p><strong>Start here:</strong> <a href="02-basic-agents.html">02-basic-agents.md</a></p>
<h3 id="3-llm-routing-25-min"><a class="header" href="#3-llm-routing-25-min">3. LLM Routing (25 min)</a></h3>
<ul>
<li>Configure multiple LLM providers</li>
<li>Route requests to optimal providers</li>
<li>Understand provider selection logic</li>
<li>Cost comparison</li>
</ul>
<p><strong>Prerequisites:</strong> Complete Basic Agents</p>
<p><strong>Start here:</strong> <a href="03-llm-routing.html">03-llm-routing.md</a></p>
<h3 id="4-learning-profiles-30-min"><a class="header" href="#4-learning-profiles-30-min">4. Learning Profiles (30 min)</a></h3>
<ul>
<li>Build expertise profiles from execution history</li>
<li>Understand recency bias</li>
<li>Confidence scoring</li>
<li>Agent improvement over time</li>
</ul>
<p><strong>Prerequisites:</strong> Complete LLM Routing</p>
<p><strong>Start here:</strong> <a href="04-learning-profiles.html">04-learning-profiles.md</a></p>
<h3 id="5-budget-management-25-min"><a class="header" href="#5-budget-management-25-min">5. Budget Management (25 min)</a></h3>
<ul>
<li>Set per-role budget limits</li>
<li>Track spending</li>
<li>Enforce budget tiers</li>
<li>Automatic fallback to cheaper providers</li>
</ul>
<p><strong>Prerequisites:</strong> Complete Learning Profiles</p>
<p><strong>Start here:</strong> <a href="05-budget-management.html">05-budget-management.md</a></p>
<h3 id="6-swarm-coordination-30-min"><a class="header" href="#6-swarm-coordination-30-min">6. Swarm Coordination (30 min)</a></h3>
<ul>
<li>Register agents in swarm</li>
<li>Assign tasks with load balancing</li>
<li>Understand scoring algorithm</li>
<li>Multi-agent workflows</li>
</ul>
<p><strong>Prerequisites:</strong> Complete Budget Management</p>
<p><strong>Start here:</strong> <a href="06-swarm-coordination.html">06-swarm-coordination.md</a></p>
<h3 id="7-knowledge-graph-25-min"><a class="header" href="#7-knowledge-graph-25-min">7. Knowledge Graph (25 min)</a></h3>
<ul>
<li>Record execution history</li>
<li>Query similar past tasks</li>
<li>Generate learning curves</li>
<li>Recommendation system</li>
</ul>
<p><strong>Prerequisites:</strong> Complete Swarm Coordination</p>
<p><strong>Start here:</strong> <a href="07-knowledge-graph.html">07-knowledge-graph.md</a></p>
<h3 id="8-rest-api-30-min"><a class="header" href="#8-rest-api-30-min">8. REST API (30 min)</a></h3>
<ul>
<li>Create projects and tasks via API</li>
<li>Manage agents through API</li>
<li>Real-time WebSocket updates</li>
<li>Error handling</li>
</ul>
<p><strong>Prerequisites:</strong> Complete Knowledge Graph</p>
<p><strong>Start here:</strong> <a href="08-rest-api.html">08-rest-api.md</a></p>
<h3 id="9-frontend-integration-20-min"><a class="header" href="#9-frontend-integration-20-min">9. Frontend Integration (20 min)</a></h3>
<ul>
<li>Leptos UI components</li>
<li>Connect frontend to backend</li>
<li>Real-time task updates</li>
<li>Kanban board usage</li>
</ul>
<p><strong>Prerequisites:</strong> Complete REST API</p>
<p><strong>Start here:</strong> <a href="09-frontend-integration.html">09-frontend-integration.md</a></p>
<h3 id="10-production-deployment-30-min"><a class="header" href="#10-production-deployment-30-min">10. Production Deployment (30 min)</a></h3>
<ul>
<li>Kubernetes deployment</li>
<li>Monitoring with Prometheus</li>
<li>Scaling agents horizontally</li>
<li>Production best practices</li>
</ul>
<p><strong>Prerequisites:</strong> Complete Frontend Integration</p>
<p><strong>Start here:</strong> <a href="10-production-deployment.html">10-production-deployment.md</a></p>
<h2 id="total-learning-time"><a class="header" href="#total-learning-time">Total Learning Time</a></h2>
<ul>
<li>Estimated: ~4 hours for complete learning path</li>
<li>Can be completed individually</li>
<li>Each tutorial is self-contained with examples</li>
</ul>
<h2 id="quick-reference"><a class="header" href="#quick-reference">Quick Reference</a></h2>
<h3 id="by-topic"><a class="header" href="#by-topic">By Topic</a></h3>
<p><strong>Agent Management</strong></p>
<ul>
<li>Tutorial 2: Basic Agents</li>
<li>Tutorial 4: Learning Profiles</li>
<li>Tutorial 6: Swarm Coordination</li>
</ul>
<p><strong>LLM &amp; Costs</strong></p>
<ul>
<li>Tutorial 3: LLM Routing</li>
<li>Tutorial 5: Budget Management</li>
</ul>
<p><strong>Data &amp; Persistence</strong></p>
<ul>
<li>Tutorial 7: Knowledge Graph</li>
<li>Tutorial 8: REST API</li>
</ul>
<p><strong>User Interfaces</strong></p>
<ul>
<li>Tutorial 9: Frontend Integration</li>
<li>Tutorial 10: Production Deployment</li>
</ul>
<h3 id="by-complexity"><a class="header" href="#by-complexity">By Complexity</a></h3>
<p><strong>Beginner</strong> (Tutorials 1-3)</p>
<ul>
<li>Get VAPORA running</li>
<li>Understand components</li>
<li>First agent execution</li>
</ul>
<p><strong>Intermediate</strong> (Tutorials 4-7)</p>
<ul>
<li>Multi-agent workflows</li>
<li>Cost control</li>
<li>Learning &amp; optimization</li>
</ul>
<p><strong>Advanced</strong> (Tutorials 8-10)</p>
<ul>
<li>Full-stack integration</li>
<li>Production deployment</li>
<li>Monitoring &amp; scaling</li>
</ul>
<h2 id="examples-directory"><a class="header" href="#examples-directory">Examples Directory</a></h2>
<p>For code examples, see <code>examples/</code>:</p>
<ul>
<li><strong>Basic examples</strong> - <code>crates/*/examples/01-*.rs</code></li>
<li><strong>Intermediate</strong> - <code>crates/*/examples/0[2-3]-*.rs</code></li>
<li><strong>Full-stack</strong> - <code>examples/full-stack/</code></li>
</ul>
<p>Each tutorial references relevant examples you can run.</p>
<h2 id="hands-on-practice"><a class="header" href="#hands-on-practice">Hands-On Practice</a></h2>
<p>Each tutorial includes:</p>
<ul>
<li>Prerequisites checklist</li>
<li>Step-by-step instructions</li>
<li>Code examples (from examples/ directory)</li>
<li>Expected output</li>
<li>Common troubleshooting</li>
<li>Next steps</li>
</ul>
<h2 id="getting-help"><a class="header" href="#getting-help">Getting Help</a></h2>
<ul>
<li>Check <strong>Troubleshooting</strong> section in each tutorial</li>
<li>Review example code in <code>examples/</code></li>
<li>Run examples with <code>--verbose</code> flag</li>
<li>Check logs: <code>RUST_LOG=debug cargo run</code></li>
</ul>
<h2 id="feedback"><a class="header" href="#feedback">Feedback</a></h2>
<p>Found an issue? Want to suggest improvements?</p>
<ul>
<li>Report issues: https://github.com/anthropics/claude-code/issues</li>
<li>Reference: "VAPORA Tutorial: [number] - [title]"</li>
</ul>
<hr />
<p><strong>Estimated completion time: 4 hours</strong></p>
<p><strong>Current progress:</strong> Pick a tutorial to start →</p>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="../../examples-guide.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="../../tutorials/02-basic-agents.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="../../examples-guide.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="../../tutorials/02-basic-agents.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>