docs: add architecture and veins documentation
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
- System overview, artery hierarchy, build flow, room config diagrams - Veins docs: Jira, Slack, Google OAuth - Shunts docs: MercadoPago mock - DOT source files with generated SVGs - HTML viewers with navigation and full-screen mode Solves: - Freelance work standardization - Missing infrastructure replication (shunts) - Reliable testing environment (BDD -> Gherkin -> Tests)
This commit is contained in:
70
docs/index.html
Normal file
70
docs/index.html
Normal file
@@ -0,0 +1,70 @@
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Soleprint - Documentation</title>
|
||||
<link rel="stylesheet" href="architecture/styles.css" />
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<h1>Soleprint</h1>
|
||||
<p class="subtitle">Cada paso deja huella / Each step leaves a mark</p>
|
||||
</header>
|
||||
|
||||
<main>
|
||||
<section class="findings-section">
|
||||
<h2>Documentation</h2>
|
||||
<div class="findings-grid">
|
||||
<a href="architecture/index.html" class="finding-card" style="text-decoration: none;">
|
||||
<h3>Architecture</h3>
|
||||
<p>System overview, connector hierarchy, build flow, and room configuration diagrams.</p>
|
||||
</a>
|
||||
<a href="veins/index.html" class="finding-card" style="text-decoration: none;">
|
||||
<h3>Veins & Shunts</h3>
|
||||
<p>API connectors (Jira, Slack, Google) and mock connectors for testing.</p>
|
||||
</a>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section class="findings-section">
|
||||
<h2>Quick Start</h2>
|
||||
<div class="finding-card">
|
||||
<h3>Build & Run</h3>
|
||||
<pre style="background: var(--bg-primary); padding: 1rem; border-radius: 4px; overflow-x: auto; margin-top: 0.5rem;">
|
||||
# Build standalone
|
||||
python build.py dev
|
||||
cd gen/standalone && .venv/bin/python run.py
|
||||
|
||||
# Build with room config
|
||||
python build.py dev --cfg amar
|
||||
cd gen/amar && .venv/bin/python run.py
|
||||
|
||||
# Visit http://localhost:12000</pre>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section class="findings-section">
|
||||
<h2>What Soleprint Solves</h2>
|
||||
<div class="findings-grid">
|
||||
<article class="finding-card">
|
||||
<h3>Freelance Work Standardization</h3>
|
||||
<p>Consistent framework across projects. Build once, reuse everywhere.</p>
|
||||
</article>
|
||||
<article class="finding-card">
|
||||
<h3>Missing Infrastructure</h3>
|
||||
<p>Mock external systems locally when you can't access client infrastructure.</p>
|
||||
</article>
|
||||
<article class="finding-card">
|
||||
<h3>Testing Environment</h3>
|
||||
<p>BDD -> Gherkin -> Tests. Explore behavior first, then generate tests.</p>
|
||||
</article>
|
||||
</div>
|
||||
</section>
|
||||
</main>
|
||||
|
||||
<footer>
|
||||
<p>Soleprint - Development Workflow Platform</p>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user