233 lines
12 KiB
HTML
233 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<link rel="stylesheet" href="css/docs.css">
|
|
<link rel="stylesheet" href="/assets/css/site-header.css">
|
|
<link rel="preload" href="/assets/css/font-awesome.min.css" as="style" onload="this.onload=null;this.rel='stylesheet'">
|
|
<noscript><link rel="stylesheet" href="/assets/css/font-awesome.min.css"></noscript>
|
|
<!-- Font Awesome CDN fallback -->
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css" crossorigin="anonymous" media="print" onload="this.media='all'; this.onload=null;">
|
|
<title>Documentation - AITBC</title>
|
|
</head>
|
|
<body>
|
|
<div data-global-header></div>
|
|
|
|
<!-- Main Content -->
|
|
<main>
|
|
<div class="container">
|
|
<div class="doc-header">
|
|
<h1>Documentation</h1>
|
|
<p>Choose your reader level to access tailored documentation for your needs</p>
|
|
<div class="announce-banner">
|
|
<h3>✅ Latest Update (February 2026)</h3>
|
|
<p>Documentation fully restructured! 10 numbered sections from Getting Started to Security, optimized content with merged duplicates, and zero broken links. Plus: end-to-end Ollama GPU inference with RTX 4060 Ti operational.</p>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Search Bar -->
|
|
<div class="search-container">
|
|
<input type="text" class="search-bar" placeholder="Search documentation..." id="searchInput">
|
|
<i class="fas fa-search search-icon"></i>
|
|
</div>
|
|
|
|
<!-- Reader Level Cards -->
|
|
<div class="reader-levels">
|
|
<!-- Miners Card -->
|
|
<div class="reader-card miner">
|
|
<div class="reader-icon">
|
|
<i class="fas fa-hammer"></i>
|
|
</div>
|
|
<h3>Miners</h3>
|
|
<p>Learn how to mine AITBC tokens and contribute to network security. Perfect for those looking to earn rewards through staking or providing compute power.</p>
|
|
<ul class="reader-features">
|
|
<li>GPU miner setup with Ollama (RTX 4060 Ti tested)</li>
|
|
<li>Systemd service configuration</li>
|
|
<li>Hardware requirements & optimization</li>
|
|
<li>Real-time job processing & earnings</li>
|
|
<li>Performance monitoring & troubleshooting</li>
|
|
</ul>
|
|
<a href="miners.html" class="btn">Miner Documentation</a>
|
|
</div>
|
|
|
|
<!-- Clients Card -->
|
|
<div class="reader-card client">
|
|
<div class="reader-icon">
|
|
<i class="fas fa-users"></i>
|
|
</div>
|
|
<h3>Clients</h3>
|
|
<p>Use AITBC for your AI/ML workloads with privacy and verifiable computation. Ideal for businesses and developers using AI services.</p>
|
|
<ul class="reader-features">
|
|
<li>CLI wrapper tool for easy job submission</li>
|
|
<li>Job status monitoring & receipt verification</li>
|
|
<li>13+ Ollama models available (llama3.2, mistral, deepseek)</li>
|
|
<li>Transparent pricing: 0.02 AITBC/gpu_second</li>
|
|
<li>Cryptographic receipts & blockchain verification</li>
|
|
</ul>
|
|
<a href="clients.html" class="btn">Client Documentation</a>
|
|
</div>
|
|
|
|
<!-- Developers Card -->
|
|
<div class="reader-card developer">
|
|
<div class="reader-icon">
|
|
<i class="fas fa-code"></i>
|
|
</div>
|
|
<h3>Developers</h3>
|
|
<p>Build on AITBC and contribute to the protocol. Designed for developers wanting to extend the platform or integrate with it.</p>
|
|
<ul class="reader-features">
|
|
<li>Development setup</li>
|
|
<li>Contribution guidelines</li>
|
|
<li>API reference</li>
|
|
<li>Bounty programs</li>
|
|
<li>Community resources</li>
|
|
</ul>
|
|
<a href="developers.html" class="btn">Developer Documentation</a>
|
|
</div>
|
|
|
|
<!-- Full Documentation Card -->
|
|
<div class="reader-card full-doc">
|
|
<div class="reader-icon">
|
|
<i class="fas fa-file-alt"></i>
|
|
</div>
|
|
<h3>Full Documentation</h3>
|
|
<p>Complete technical documentation covering all aspects of the AITBC platform including architecture, APIs, deployment, and advanced features.</p>
|
|
<ul class="reader-features">
|
|
<li>Architecture overview</li>
|
|
<li>Complete API reference</li>
|
|
<li>Deployment guides</li>
|
|
<li>Security documentation</li>
|
|
<li>Advanced configurations</li>
|
|
</ul>
|
|
<a href="full-documentation.html" class="btn">View Full Documentation</a>
|
|
</div>
|
|
|
|
<!-- Components Card -->
|
|
<div class="reader-card components">
|
|
<div class="reader-icon">
|
|
<i class="fas fa-cube"></i>
|
|
</div>
|
|
<h3>Architecture & Components</h3>
|
|
<p>Explore the system architecture and core components of the AITBC platform. Understand how each part works together from end-to-end flow to individual services.</p>
|
|
<ul class="reader-features">
|
|
<li>End-to-end system flow diagram</li>
|
|
<li>Coordinator API for job orchestration</li>
|
|
<li>Blockchain Node with PoA/PoS consensus</li>
|
|
<li>Marketplace Web for compute trading</li>
|
|
<li>Trade Exchange for BTC-to-AITBC</li>
|
|
<li>Wallet for key management & staking</li>
|
|
<li>Codebase structure & technical reference</li>
|
|
</ul>
|
|
<a href="components.html" class="btn">View Architecture</a>
|
|
</div>
|
|
|
|
<!-- System Flow Card -->
|
|
<div class="reader-card flow">
|
|
<div class="reader-icon">
|
|
<i class="fas fa-sitemap"></i>
|
|
</div>
|
|
<h3>System Flow</h3>
|
|
<p>Visualize the complete flow of a job submission through the CLI client, detailing each system component, message, RPC call, and port involved.</p>
|
|
<ul class="reader-features">
|
|
<li>End-to-end job submission flow</li>
|
|
<li>Component interaction diagrams</li>
|
|
<li>API call sequences</li>
|
|
<li>Error handling paths</li>
|
|
<li>Performance monitoring points</li>
|
|
</ul>
|
|
<a href="flowchart.html" class="btn">View System Flow</a>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Quick Links -->
|
|
<section class="quick-links">
|
|
<h2>Quick Links</h2>
|
|
<div class="links-grid">
|
|
<a href="full-documentation.html" class="link-item">
|
|
<i class="fas fa-book"></i>
|
|
<span>Full Documentation</span>
|
|
</a>
|
|
<a href="https://github.com/oib/AITBC/tree/main/docs" class="link-item" target="_blank">
|
|
<i class="fas fa-file-alt"></i>
|
|
<span>Markdown Docs</span>
|
|
</a>
|
|
<a href="https://aitbc.bubuit.net/Exchange/" class="link-item">
|
|
<i class="fas fa-exchange"></i>
|
|
<span>Trade Exchange</span>
|
|
</a>
|
|
<a href="https://github.com/oib/AITBC" class="link-item">
|
|
<i class="fas fa-git"></i>
|
|
<span>Source Code</span>
|
|
</a>
|
|
<a href="mailto:andreas.fleckl@bubuit.net" class="link-item">
|
|
<i class="fas fa-envelope"></i>
|
|
<span>Support</span>
|
|
</a>
|
|
</div>
|
|
</section>
|
|
|
|
<!-- Help Section -->
|
|
<section class="help-section">
|
|
<h2>Need Help?</h2>
|
|
<p>Can't find what you're looking for? Our support team is here to help!</p>
|
|
<div class="help-buttons">
|
|
<a href="mailto:andreas.fleckl@bubuit.net" class="btn btn-outline">
|
|
<i class="fas fa-envelope"></i> Email Support
|
|
</a>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</main>
|
|
|
|
<!-- Footer -->
|
|
<footer>
|
|
<div class="container">
|
|
<p>© 2026 AITBC. All rights reserved. | Last updated: February 13, 2026</p>
|
|
</div>
|
|
</footer>
|
|
|
|
<script>
|
|
// Client-side search across doc pages
|
|
const docPages = [
|
|
{ title: 'Miner Documentation', desc: 'GPU mining, registration, earnings, Ollama setup', url: 'miners.html' },
|
|
{ title: 'Client Documentation', desc: 'Job submission, wallet, pricing, API reference', url: 'clients.html' },
|
|
{ title: 'Developer Documentation', desc: 'SDKs, APIs, contributing, bounties', url: 'developers.html' },
|
|
{ title: 'Full Documentation', desc: 'Architecture, installation, APIs, security, reference', url: 'full-documentation.html' },
|
|
{ title: 'Architecture & Components', desc: 'Blockchain node, coordinator, marketplace, wallet, explorer, pool hub', url: 'components.html' },
|
|
{ title: 'System Flow', desc: 'Job submission flow, component interaction, RPC calls', url: 'flowchart.html' },
|
|
{ title: 'Coordinator API', desc: 'FastAPI, job management, miner registration, receipts', url: 'coordinator-api.html' },
|
|
{ title: 'Blockchain Node', desc: 'PoA consensus, RPC, P2P, devnet, validator', url: 'blockchain-node.html' },
|
|
{ title: 'Trade Exchange', desc: 'Bitcoin to AITBC, QR payments, user management', url: 'trade-exchange.html' },
|
|
{ title: 'Marketplace Web', desc: 'GPU compute offers, bids, stats dashboard', url: 'marketplace-web.html' },
|
|
{ title: 'Wallet Daemon', desc: 'Encrypted keystore, Argon2id, REST API, receipts', url: 'wallet-daemon.html' },
|
|
{ title: 'Explorer Web', desc: 'Blocks, transactions, addresses, receipt tracking', url: 'explorer-web.html' },
|
|
{ title: 'Pool Hub', desc: 'Miner registry, scoring, Redis, PostgreSQL', url: 'pool-hub.html' },
|
|
{ title: 'API Reference', desc: 'REST endpoints, authentication, rate limits', url: 'api.html' },
|
|
{ title: 'Browser Wallet', desc: 'Chrome extension, secure crypto wallet', url: 'browser-wallet.html' },
|
|
];
|
|
|
|
document.getElementById('searchInput').addEventListener('input', function(e) {
|
|
const q = e.target.value.toLowerCase().trim();
|
|
let resultsEl = document.getElementById('searchResults');
|
|
if (!resultsEl) {
|
|
resultsEl = document.createElement('div');
|
|
resultsEl.id = 'searchResults';
|
|
resultsEl.className = 'search-results';
|
|
this.closest('.search-container').after(resultsEl);
|
|
}
|
|
if (!q || q.length < 2) { resultsEl.innerHTML = ''; return; }
|
|
const matches = docPages.filter(p => p.title.toLowerCase().includes(q) || p.desc.toLowerCase().includes(q));
|
|
if (matches.length === 0) {
|
|
resultsEl.innerHTML = '<div class="no-results">No results found</div>';
|
|
} else {
|
|
resultsEl.innerHTML = matches.map(p =>
|
|
`<a href="${p.url}"><strong>${p.title}</strong><br><small>${p.desc}</small></a>`
|
|
).join('');
|
|
}
|
|
});
|
|
</script>
|
|
<script src="js/theme.js"></script>
|
|
<script src="/assets/js/global-header.js"></script>
|
|
</body>
|
|
</html>
|