docs: fix styling and content
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
- Black background instead of blue - Remove 'dev' from build commands - Shorter problem descriptions - Fix missing infrastructure description (DBs, APIs, K8s)
This commit is contained in:
buenosairesam
@@ -9,7 +9,9 @@
|
||||
<body>
|
||||
<header>
|
||||
<h1>Soleprint</h1>
|
||||
<p class="subtitle">Cada paso deja huella / Each step leaves a mark</p>
|
||||
<p class="subtitle">
|
||||
Cada paso deja huella / Each step leaves a mark
|
||||
</p>
|
||||
</header>
|
||||
|
||||
<main>
|
||||
@@ -19,15 +21,25 @@
|
||||
<div class="findings-grid">
|
||||
<article class="finding-card">
|
||||
<h3>Freelance Work Standardization</h3>
|
||||
<p>Generalizing and homogenizing freelance work across projects. Instead of setting up different environments, testing approaches, and connector patterns for each client, Soleprint provides a consistent framework. Build once, reuse everywhere.</p>
|
||||
<p>
|
||||
Consistent framework across projects. Build once,
|
||||
reuse everywhere.
|
||||
</p>
|
||||
</article>
|
||||
<article class="finding-card">
|
||||
<h3>Missing Infrastructure Replication</h3>
|
||||
<p>When working with large corps where you can't access their Jira, Slack, payment systems, or internal APIs directly - Soleprint's shunts let you mock those systems locally. Test against fake MercadoPago, fake Jira tickets, fake webhooks without needing real credentials.</p>
|
||||
<h3>Missing Infrastructure</h3>
|
||||
<p>
|
||||
Mock systems you can't access yet - DB designs in
|
||||
progress, Kubernetes not ready, APIs being built.
|
||||
Test locally with shunts.
|
||||
</p>
|
||||
</article>
|
||||
<article class="finding-card">
|
||||
<h3>Reliable Testing Environment</h3>
|
||||
<p>Figure out what tests to write by actually running flows in a controlled environment. BDD -> Gherkin -> Tests workflow. Instead of guessing what to test, you explore the actual behavior first, document it, then generate tests from that documentation.</p>
|
||||
<h3>Reliable Testing</h3>
|
||||
<p>
|
||||
BDD -> Gherkin -> Tests. Explore behavior first,
|
||||
then generate tests.
|
||||
</p>
|
||||
</article>
|
||||
</div>
|
||||
</section>
|
||||
@@ -36,7 +48,9 @@
|
||||
<section class="graph-section" id="overview">
|
||||
<div class="graph-header-row">
|
||||
<h2>System Overview</h2>
|
||||
<a href="graph.html?g=01-system-overview" class="view-btn">View Full</a>
|
||||
<a href="graph.html?g=01-system-overview" class="view-btn"
|
||||
>View Full</a
|
||||
>
|
||||
</div>
|
||||
<a href="graph.html?g=01-system-overview" class="graph-preview">
|
||||
<img src="01-system-overview.svg" alt="System Overview" />
|
||||
@@ -45,10 +59,22 @@
|
||||
<p>The four systems that make up Soleprint.</p>
|
||||
<h4>Systems</h4>
|
||||
<ul>
|
||||
<li><strong>Soleprint</strong>: Core coordinator hub (port 12000)</li>
|
||||
<li><strong>Artery</strong>: Connectors to external services - "Todo lo vital"</li>
|
||||
<li><strong>Atlas</strong>: Actionable documentation - "Documentacion accionable"</li>
|
||||
<li><strong>Station</strong>: Tools and monitors - "Centro de control"</li>
|
||||
<li>
|
||||
<strong>Soleprint</strong>: Core coordinator hub
|
||||
(port 12000)
|
||||
</li>
|
||||
<li>
|
||||
<strong>Artery</strong>: Connectors to external
|
||||
services - "Todo lo vital"
|
||||
</li>
|
||||
<li>
|
||||
<strong>Atlas</strong>: Actionable documentation -
|
||||
"Documentacion accionable"
|
||||
</li>
|
||||
<li>
|
||||
<strong>Station</strong>: Tools and monitors -
|
||||
"Centro de control"
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
@@ -57,9 +83,14 @@
|
||||
<section class="graph-section" id="artery">
|
||||
<div class="graph-header-row">
|
||||
<h2>Artery Hierarchy</h2>
|
||||
<a href="graph.html?g=02-artery-hierarchy" class="view-btn">View Full</a>
|
||||
<a href="graph.html?g=02-artery-hierarchy" class="view-btn"
|
||||
>View Full</a
|
||||
>
|
||||
</div>
|
||||
<a href="graph.html?g=02-artery-hierarchy" class="graph-preview">
|
||||
<a
|
||||
href="graph.html?g=02-artery-hierarchy"
|
||||
class="graph-preview"
|
||||
>
|
||||
<img src="02-artery-hierarchy.svg" alt="Artery Hierarchy" />
|
||||
</a>
|
||||
<div class="graph-details">
|
||||
@@ -103,7 +134,9 @@
|
||||
<section class="graph-section" id="build">
|
||||
<div class="graph-header-row">
|
||||
<h2>Build Flow</h2>
|
||||
<a href="graph.html?g=03-build-flow" class="view-btn">View Full</a>
|
||||
<a href="graph.html?g=03-build-flow" class="view-btn"
|
||||
>View Full</a
|
||||
>
|
||||
</div>
|
||||
<a href="graph.html?g=03-build-flow" class="graph-preview">
|
||||
<img src="03-build-flow.svg" alt="Build Flow" />
|
||||
@@ -120,15 +153,17 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>python build.py dev</code></td>
|
||||
<td><code>python build.py</code></td>
|
||||
<td>gen/standalone/</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>python build.py dev --cfg amar</code></td>
|
||||
<td>
|
||||
<code>python build.py --cfg amar</code>
|
||||
</td>
|
||||
<td>gen/amar/</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>python build.py dev --all</code></td>
|
||||
<td><code>python build.py --all</code></td>
|
||||
<td>both</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -140,7 +175,9 @@
|
||||
<section class="graph-section" id="room">
|
||||
<div class="graph-header-row">
|
||||
<h2>Room Configuration</h2>
|
||||
<a href="graph.html?g=04-room-config" class="view-btn">View Full</a>
|
||||
<a href="graph.html?g=04-room-config" class="view-btn"
|
||||
>View Full</a
|
||||
>
|
||||
</div>
|
||||
<a href="graph.html?g=04-room-config" class="graph-preview">
|
||||
<img src="04-room-config.svg" alt="Room Configuration" />
|
||||
@@ -149,10 +186,24 @@
|
||||
<p>How rooms are configured in cfg/.</p>
|
||||
<h4>Room Structure</h4>
|
||||
<ul>
|
||||
<li><strong>config.json</strong>: Framework branding, terminology</li>
|
||||
<li><strong>data/</strong>: veins.json, shunts.json, depots.json</li>
|
||||
<li><strong>soleprint/</strong>: Docker config for this room</li>
|
||||
<li><strong>databrowse/, tester/, monitors/, models/</strong>: Room-specific extensions</li>
|
||||
<li>
|
||||
<strong>config.json</strong>: Framework branding,
|
||||
terminology
|
||||
</li>
|
||||
<li>
|
||||
<strong>data/</strong>: veins.json, shunts.json,
|
||||
depots.json
|
||||
</li>
|
||||
<li>
|
||||
<strong>soleprint/</strong>: Docker config for this
|
||||
room
|
||||
</li>
|
||||
<li>
|
||||
<strong
|
||||
>databrowse/, tester/, monitors/,
|
||||
models/</strong
|
||||
>: Room-specific extensions
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
@@ -200,7 +251,9 @@
|
||||
|
||||
<footer>
|
||||
<p>Soleprint - Development Workflow Platform</p>
|
||||
<p class="date">Generated: <time datetime="2025-01">January 2025</time></p>
|
||||
<p class="date">
|
||||
Generated: <time datetime="2025-01">January 2025</time>
|
||||
</p>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
:root {
|
||||
--bg-primary: #1a1a2e;
|
||||
--bg-secondary: #16213e;
|
||||
--bg-card: #0f3460;
|
||||
--bg-primary: #0a0a0a;
|
||||
--bg-secondary: #141414;
|
||||
--bg-card: #1a1a1a;
|
||||
--text-primary: #eee;
|
||||
--text-secondary: #a0a0a0;
|
||||
--accent: #e94560;
|
||||
--accent-secondary: #533483;
|
||||
--border: #2a2a4a;
|
||||
--border: #2a2a2a;
|
||||
}
|
||||
|
||||
* {
|
||||
@@ -16,14 +16,22 @@
|
||||
}
|
||||
|
||||
body {
|
||||
font-family: 'Segoe UI', system-ui, -apple-system, sans-serif;
|
||||
font-family:
|
||||
"Segoe UI",
|
||||
system-ui,
|
||||
-apple-system,
|
||||
sans-serif;
|
||||
background: var(--bg-primary);
|
||||
color: var(--text-primary);
|
||||
line-height: 1.6;
|
||||
}
|
||||
|
||||
header {
|
||||
background: linear-gradient(135deg, var(--bg-secondary), var(--accent-secondary));
|
||||
background: linear-gradient(
|
||||
135deg,
|
||||
var(--bg-secondary),
|
||||
var(--accent-secondary)
|
||||
);
|
||||
padding: 2rem;
|
||||
text-align: center;
|
||||
border-bottom: 2px solid var(--accent);
|
||||
|
||||
@@ -9,20 +9,36 @@
|
||||
<body>
|
||||
<header>
|
||||
<h1>Soleprint</h1>
|
||||
<p class="subtitle">Cada paso deja huella / Each step leaves a mark</p>
|
||||
<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;">
|
||||
<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>
|
||||
<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;">
|
||||
<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>
|
||||
<p>
|
||||
API connectors (Jira, Slack, Google) and mock
|
||||
connectors for testing.
|
||||
</p>
|
||||
</a>
|
||||
</div>
|
||||
</section>
|
||||
@@ -31,16 +47,25 @@
|
||||
<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;">
|
||||
<pre
|
||||
style="
|
||||
background: var(--bg-primary);
|
||||
padding: 1rem;
|
||||
border-radius: 4px;
|
||||
overflow-x: auto;
|
||||
margin-top: 0.5rem;
|
||||
"
|
||||
>
|
||||
# Build standalone
|
||||
python build.py dev
|
||||
python build.py
|
||||
cd gen/standalone && .venv/bin/python run.py
|
||||
|
||||
# Build with room config
|
||||
python build.py dev --cfg amar
|
||||
python build.py --cfg amar
|
||||
cd gen/amar && .venv/bin/python run.py
|
||||
|
||||
# Visit http://localhost:12000</pre>
|
||||
# Visit http://localhost:12000</pre
|
||||
>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
@@ -48,16 +73,18 @@ cd gen/amar && .venv/bin/python run.py
|
||||
<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>
|
||||
<h3>Freelance Standardization</h3>
|
||||
<p>Consistent framework across projects.</p>
|
||||
</article>
|
||||
<article class="finding-card">
|
||||
<h3>Missing Infrastructure</h3>
|
||||
<p>Mock external systems locally when you can't access client infrastructure.</p>
|
||||
<p>
|
||||
Mock systems not ready yet - DBs, APIs, Kubernetes.
|
||||
</p>
|
||||
</article>
|
||||
<article class="finding-card">
|
||||
<h3>Testing Environment</h3>
|
||||
<p>BDD -> Gherkin -> Tests. Explore behavior first, then generate tests.</p>
|
||||
<h3>Reliable Testing</h3>
|
||||
<p>BDD -> Gherkin -> Tests.</p>
|
||||
</article>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
Reference in New Issue
Block a user