Improve soleprint docs: bilingual EN/ES, system pages, architecture cleanup
This commit is contained in:
buenosairesam
267
docs/index.html
267
docs/index.html
@@ -5,39 +5,151 @@
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Soleprint - Documentation</title>
|
||||
<link rel="stylesheet" href="architecture/styles.css" />
|
||||
<style>
|
||||
.one-liner {
|
||||
font-size: 1.2rem;
|
||||
color: var(--text-secondary);
|
||||
margin-top: 0.5rem;
|
||||
}
|
||||
.demo-link {
|
||||
display: inline-block;
|
||||
margin-top: 1rem;
|
||||
padding: 0.5rem 1rem;
|
||||
background: var(--accent);
|
||||
color: var(--bg-primary);
|
||||
text-decoration: none;
|
||||
border-radius: 4px;
|
||||
font-weight: 500;
|
||||
}
|
||||
.demo-link:hover {
|
||||
opacity: 0.9;
|
||||
}
|
||||
.systems-grid {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
|
||||
gap: 1rem;
|
||||
margin: 1rem 0;
|
||||
}
|
||||
.system-card {
|
||||
background: var(--bg-secondary);
|
||||
padding: 1rem;
|
||||
border-radius: 8px;
|
||||
border-left: 3px solid var(--accent);
|
||||
}
|
||||
.system-card h3 {
|
||||
margin: 0 0 0.5rem 0;
|
||||
color: var(--text-primary);
|
||||
}
|
||||
.system-card p {
|
||||
margin: 0;
|
||||
color: var(--text-secondary);
|
||||
font-size: 0.9rem;
|
||||
}
|
||||
.arch-grid {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fit, minmax(220px, 1fr));
|
||||
gap: 1rem;
|
||||
margin: 1rem 0;
|
||||
}
|
||||
.arch-card {
|
||||
display: block;
|
||||
background: var(--bg-secondary);
|
||||
padding: 1rem;
|
||||
border-radius: 8px;
|
||||
text-decoration: none;
|
||||
transition: transform 0.15s;
|
||||
}
|
||||
.arch-card:hover {
|
||||
transform: translateY(-2px);
|
||||
}
|
||||
.arch-card h4 {
|
||||
margin: 0 0 0.5rem 0;
|
||||
color: var(--text-primary);
|
||||
}
|
||||
.arch-card p {
|
||||
margin: 0;
|
||||
color: var(--text-secondary);
|
||||
font-size: 0.85rem;
|
||||
}
|
||||
pre {
|
||||
background: var(--bg-primary);
|
||||
padding: 1rem;
|
||||
border-radius: 4px;
|
||||
overflow-x: auto;
|
||||
margin-top: 0.5rem;
|
||||
}
|
||||
</style>
|
||||
<script src="lang-toggle.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div id="lang-toggle"></div>
|
||||
<h1>Soleprint</h1>
|
||||
<p class="subtitle">
|
||||
Cada paso deja huella / Each step leaves a mark
|
||||
<p class="subtitle">Cada paso deja huella</p>
|
||||
<p class="one-liner">
|
||||
<span class="lang-en"
|
||||
>Pluggable stuff to tackle any challenge</span
|
||||
>
|
||||
<span class="lang-es"
|
||||
>Piezas enchufables para cualquier desafio</span
|
||||
>
|
||||
</p>
|
||||
<a href="https://sample.spr.mcrn.ar" class="demo-link">
|
||||
<span class="lang-en">Try the Demo</span>
|
||||
<span class="lang-es">Ver Demo</span>
|
||||
</a>
|
||||
</header>
|
||||
|
||||
<main>
|
||||
<section class="findings-section">
|
||||
<h2>Documentation</h2>
|
||||
<div class="findings-grid">
|
||||
<h2>
|
||||
<span class="lang-en">The Three Systems</span>
|
||||
<span class="lang-es">Los Tres Sistemas</span>
|
||||
</h2>
|
||||
<div class="systems-grid">
|
||||
<a
|
||||
href="architecture/index.html"
|
||||
class="finding-card"
|
||||
href="artery/"
|
||||
class="system-card"
|
||||
style="text-decoration: none"
|
||||
>
|
||||
<h3>Architecture</h3>
|
||||
<p>
|
||||
System overview, connector hierarchy, build flow,
|
||||
and room configuration diagrams.
|
||||
<h3>Artery</h3>
|
||||
<p class="lang-en">
|
||||
API connectors and data flow. Veins for real APIs,
|
||||
shunts for mocks.
|
||||
</p>
|
||||
<p class="lang-es">
|
||||
Conectores y flujo de datos. Veins para APIs reales,
|
||||
shunts para mocks.
|
||||
</p>
|
||||
</a>
|
||||
<a
|
||||
href="veins/index.html"
|
||||
class="finding-card"
|
||||
href="atlas/"
|
||||
class="system-card"
|
||||
style="text-decoration: none"
|
||||
>
|
||||
<h3>Veins & Shunts</h3>
|
||||
<p>
|
||||
API connectors (Jira, Slack, Google) and mock
|
||||
connectors for testing.
|
||||
<h3>Atlas</h3>
|
||||
<p class="lang-en">
|
||||
Actionable documentation. Templates that generate
|
||||
living docs.
|
||||
</p>
|
||||
<p class="lang-es">
|
||||
Documentacion accionable. Templates que generan docs
|
||||
vivos.
|
||||
</p>
|
||||
</a>
|
||||
<a
|
||||
href="station/"
|
||||
class="system-card"
|
||||
style="text-decoration: none"
|
||||
>
|
||||
<h3>Station</h3>
|
||||
<p class="lang-en">
|
||||
Tools and monitors. Everything to run, test, and
|
||||
observe.
|
||||
</p>
|
||||
<p class="lang-es">
|
||||
Herramientas y monitores. Todo para correr, testear,
|
||||
y observar.
|
||||
</p>
|
||||
</a>
|
||||
</div>
|
||||
@@ -45,53 +157,106 @@
|
||||
|
||||
<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
|
||||
cd gen/standalone && .venv/bin/python run.py
|
||||
<pre>
|
||||
# Clone
|
||||
git clone https://git.mcrn.ar/soleprint
|
||||
cd soleprint
|
||||
|
||||
# Build with room config
|
||||
python build.py --cfg amar
|
||||
cd gen/amar && .venv/bin/python run.py
|
||||
# Setup (once)
|
||||
python -m venv .venv && source .venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
|
||||
# Visit http://localhost:12000</pre
|
||||
>
|
||||
</div>
|
||||
# Option 1: Build standalone (soleprint only)
|
||||
python build.py --cfg standalone
|
||||
cd gen/standalone && ./ctrl/start.sh
|
||||
# Visit http://localhost:12000
|
||||
|
||||
# Option 2: Build managed room (soleprint + your app)
|
||||
python build.py --cfg myroom
|
||||
cd gen/myroom && ./ctrl/start.sh
|
||||
# Visit http://myroom.spr.local.ar
|
||||
|
||||
# Option 3: Use the installer (coming soon)</pre
|
||||
>
|
||||
|
||||
<p style="margin-top: 1rem">
|
||||
<span class="lang-en">Minimal config example:</span>
|
||||
<span class="lang-es">Ejemplo de config minima:</span>
|
||||
</p>
|
||||
<pre>
|
||||
// cfg/myroom/config.json
|
||||
{
|
||||
"room": "myroom",
|
||||
"artery": {
|
||||
"veins": ["google", "jira", "slack"],
|
||||
"shunts": ["mercadopago"]
|
||||
},
|
||||
"atlas": {
|
||||
"books": ["gherkin", "feature-flow"]
|
||||
},
|
||||
"station": {
|
||||
"tools": ["tester", "modelgen"],
|
||||
"monitors": ["databrowse"]
|
||||
}
|
||||
}</pre
|
||||
>
|
||||
</section>
|
||||
|
||||
<section class="findings-section">
|
||||
<h2>What Soleprint Solves</h2>
|
||||
<h2>
|
||||
<span class="lang-en">Architecture</span>
|
||||
<span class="lang-es">Arquitectura</span>
|
||||
</h2>
|
||||
<p class="lang-en">Deep dive into how soleprint works.</p>
|
||||
<p class="lang-es">Profundizando en como funciona soleprint.</p>
|
||||
<div class="findings-grid">
|
||||
<article class="finding-card">
|
||||
<h3>Freelance Standardization</h3>
|
||||
<p>Consistent framework across projects.</p>
|
||||
</article>
|
||||
<article class="finding-card">
|
||||
<h3>Missing Infrastructure</h3>
|
||||
<p>
|
||||
Mock systems not ready yet - DBs, APIs, Kubernetes.
|
||||
<a
|
||||
href="architecture/"
|
||||
class="finding-card"
|
||||
style="text-decoration: none"
|
||||
>
|
||||
<h3>
|
||||
<span class="lang-en">Architecture Diagrams →</span
|
||||
><span class="lang-es"
|
||||
>Diagramas de Arquitectura →</span
|
||||
>
|
||||
</h3>
|
||||
<p class="lang-en">
|
||||
System overview, artery hierarchy, build flow, room
|
||||
configuration.
|
||||
</p>
|
||||
</article>
|
||||
<article class="finding-card">
|
||||
<h3>Reliable Testing</h3>
|
||||
<p>BDD -> Gherkin -> Tests.</p>
|
||||
</article>
|
||||
<p class="lang-es">
|
||||
Vista general, jerarquia de artery, flujo de build,
|
||||
configuracion de rooms.
|
||||
</p>
|
||||
</a>
|
||||
<a
|
||||
href="architecture/sidebar-injection.html"
|
||||
class="finding-card"
|
||||
style="text-decoration: none"
|
||||
>
|
||||
<h3>
|
||||
<span class="lang-en">Sidebar Injection →</span
|
||||
><span class="lang-es">Inyeccion de Sidebar →</span>
|
||||
</h3>
|
||||
<p class="lang-en">
|
||||
How the managed room sidebar works with nginx +
|
||||
JavaScript.
|
||||
</p>
|
||||
<p class="lang-es">
|
||||
Como funciona el sidebar del managed room con nginx
|
||||
+ JavaScript.
|
||||
</p>
|
||||
</a>
|
||||
</div>
|
||||
</section>
|
||||
</main>
|
||||
|
||||
<footer>
|
||||
<p>Soleprint - Development Workflow Platform</p>
|
||||
<p>
|
||||
<a href="https://soleprint.mcrn.ar">soleprint.mcrn.ar</a> ·
|
||||
<a href="https://sample.spr.mcrn.ar">Live Demo</a>
|
||||
</p>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user