mariano/soleprint
Public Access
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix styling and content
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
Details

Browse Source 
- 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
2026-01-02 22:56:47 -03:00
parent 22356fed66
commit 47cd737bc0
3 changed files with 131 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
docs/architecture/index.html
View File

@@ -9,7 +9,9 @@
<body> <body>
<header> <header>
<h1>Soleprint</h1> <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> </header>
<main> <main>
@@ -19,15 +21,25 @@
<div class="findings-grid"> <div class="findings-grid">
<article class="finding-card"> <article class="finding-card">
<h3>Freelance Work Standardization</h3> <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>
<article class="finding-card"> <article class="finding-card">
<h3>Missing Infrastructure Replication</h3> <h3>Missing Infrastructure</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> <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>
<article class="finding-card"> <article class="finding-card">
<h3>Reliable Testing Environment</h3> <h3>Reliable Testing</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> <p>
BDD -> Gherkin -> Tests. Explore behavior first,
then generate tests.
</p>
</article> </article>
</div> </div>
</section> </section>
@@ -36,7 +48,9 @@
<section class="graph-section" id="overview"> <section class="graph-section" id="overview">
<div class="graph-header-row"> <div class="graph-header-row">
<h2>System Overview</h2> <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> </div>
<a href="graph.html?g=01-system-overview" class="graph-preview"> <a href="graph.html?g=01-system-overview" class="graph-preview">
<img src="01-system-overview.svg" alt="System Overview" /> <img src="01-system-overview.svg" alt="System Overview" />
@@ -45,10 +59,22 @@
<p>The four systems that make up Soleprint.</p> <p>The four systems that make up Soleprint.</p>
<h4>Systems</h4> <h4>Systems</h4>
<ul> <ul>
<li><strong>Soleprint</strong>: Core coordinator hub (port 12000)</li> <li>
<li><strong>Artery</strong>: Connectors to external services - "Todo lo vital"</li> <strong>Soleprint</strong>: Core coordinator hub
<li><strong>Atlas</strong>: Actionable documentation - "Documentacion accionable"</li> (port 12000)
<li><strong>Station</strong>: Tools and monitors - "Centro de control"</li> </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> </ul>
</div> </div>
</section> </section>
@@ -57,9 +83,14 @@
<section class="graph-section" id="artery"> <section class="graph-section" id="artery">
<div class="graph-header-row"> <div class="graph-header-row">
<h2>Artery Hierarchy</h2> <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> </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" /> <img src="02-artery-hierarchy.svg" alt="Artery Hierarchy" />
</a> </a>
<div class="graph-details"> <div class="graph-details">
@@ -103,7 +134,9 @@
<section class="graph-section" id="build"> <section class="graph-section" id="build">
<div class="graph-header-row"> <div class="graph-header-row">
<h2>Build Flow</h2> <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> </div>
<a href="graph.html?g=03-build-flow" class="graph-preview"> <a href="graph.html?g=03-build-flow" class="graph-preview">
<img src="03-build-flow.svg" alt="Build Flow" /> <img src="03-build-flow.svg" alt="Build Flow" />
@@ -120,15 +153,17 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td><code>python build.py dev</code></td> <td><code>python build.py</code></td>
<td>gen/standalone/</td> <td>gen/standalone/</td>
</tr> </tr>
<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> <td>gen/amar/</td>
</tr> </tr>
<tr> <tr>
<td><code>python build.py dev --all</code></td> <td><code>python build.py --all</code></td>
<td>both</td> <td>both</td>
</tr> </tr>
</tbody> </tbody>
@@ -140,7 +175,9 @@
<section class="graph-section" id="room"> <section class="graph-section" id="room">
<div class="graph-header-row"> <div class="graph-header-row">
<h2>Room Configuration</h2> <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> </div>
<a href="graph.html?g=04-room-config" class="graph-preview"> <a href="graph.html?g=04-room-config" class="graph-preview">
<img src="04-room-config.svg" alt="Room Configuration" /> <img src="04-room-config.svg" alt="Room Configuration" />
@@ -149,10 +186,24 @@
<p>How rooms are configured in cfg/.</p> <p>How rooms are configured in cfg/.</p>
<h4>Room Structure</h4> <h4>Room Structure</h4>
<ul> <ul>
<li><strong>config.json</strong>: Framework branding, terminology</li> <li>
<li><strong>data/</strong>: veins.json, shunts.json, depots.json</li> <strong>config.json</strong>: Framework branding,
<li><strong>soleprint/</strong>: Docker config for this room</li> terminology
<li><strong>databrowse/, tester/, monitors/, models/</strong>: Room-specific extensions</li> </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> </ul>
</div> </div>
</section> </section>
@@ -200,7 +251,9 @@
<footer> <footer>
<p>Soleprint - Development Workflow Platform</p> <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> </footer>
</body> </body>
</html> </html>

20
docs/architecture/styles.css
View File

@@ -1,12 +1,12 @@
:root { :root {
--bg-primary: #1a1a2e; --bg-primary: #0a0a0a;
--bg-secondary: #16213e; --bg-secondary: #141414;
--bg-card: #0f3460; --bg-card: #1a1a1a;
--text-primary: #eee; --text-primary: #eee;
--text-secondary: #a0a0a0; --text-secondary: #a0a0a0;
--accent: #e94560; --accent: #e94560;
--accent-secondary: #533483; --accent-secondary: #533483;
--border: #2a2a4a; --border: #2a2a2a;
} }
* { * {
@@ -16,14 +16,22 @@
} }
body { 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); background: var(--bg-primary);
color: var(--text-primary); color: var(--text-primary);
line-height: 1.6; line-height: 1.6;
} }
header { header {
background: linear-gradient(135deg, var(--bg-secondary), var(--accent-secondary)); background: linear-gradient(
135deg,
var(--bg-secondary),
var(--accent-secondary)
);
padding: 2rem; padding: 2rem;
text-align: center; text-align: center;
border-bottom: 2px solid var(--accent); border-bottom: 2px solid var(--accent);

55
docs/index.html
View File

@@ -9,20 +9,36 @@
<body> <body>
<header> <header>
<h1>Soleprint</h1> <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> </header>
<main> <main>
<section class="findings-section"> <section class="findings-section">
<h2>Documentation</h2> <h2>Documentation</h2>
<div class="findings-grid"> <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> <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>
<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> <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> </a>
</div> </div>
</section> </section>
@@ -31,16 +47,25 @@
<h2>Quick Start</h2> <h2>Quick Start</h2>
<div class="finding-card"> <div class="finding-card">
<h3>Build & Run</h3> <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 # Build standalone
python build.py dev python build.py
cd gen/standalone && .venv/bin/python run.py cd gen/standalone && .venv/bin/python run.py
# Build with room config # Build with room config
python build.py dev --cfg amar python build.py --cfg amar
cd gen/amar && .venv/bin/python run.py cd gen/amar && .venv/bin/python run.py
# Visit http://localhost:12000</pre> # Visit http://localhost:12000</pre
>
</div> </div>
</section> </section>
@@ -48,16 +73,18 @@ cd gen/amar && .venv/bin/python run.py
<h2>What Soleprint Solves</h2> <h2>What Soleprint Solves</h2>
<div class="findings-grid"> <div class="findings-grid">
<article class="finding-card"> <article class="finding-card">
<h3>Freelance Work Standardization</h3> <h3>Freelance Standardization</h3>
<p>Consistent framework across projects. Build once, reuse everywhere.</p> <p>Consistent framework across projects.</p>
</article> </article>
<article class="finding-card"> <article class="finding-card">
<h3>Missing Infrastructure</h3> <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>
<article class="finding-card"> <article class="finding-card">
<h3>Testing Environment</h3> <h3>Reliable Testing</h3>
<p>BDD -> Gherkin -> Tests. Explore behavior first, then generate tests.</p> <p>BDD -> Gherkin -> Tests.</p>
</article> </article>
</div> </div>
</section> </section>