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

update docs

Browse Source
This commit is contained in:
buenosairesam
2026-05-06 12:04:19 -03:00
parent 973f0a01c9
commit 9fc4c23143
4 changed files with 7 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -2,44 +2,14 @@
Development workflow platform. Wraps existing applications with tools, testing, and documentation — without touching source code. Development workflow platform. Wraps existing applications with tools, testing, and documentation — without touching source code.
Cada paso deja huella. *Cada paso deja huella.*
## Quick Start ---
```bash
# Create a room
python -m init.cli myroom
# Build
python build.py --cfg myroom
# Run
cd gen/myroom/soleprint && docker compose up
# Visit http://localhost:12000
```
Or use the browser wizard: `python -m init.web` → http://localhost:9000
## Docs ## Docs
```bash ```bash
cd docs && python -m http.server 8080 cd docs && python -m http.server 8080
# http://localhost:8080
``` ```
## Structure Visit `http://localhost:8080`. Start with [Concepts](docs/data/en/concepts.md) for the mental model, then [Quickstart](docs/data/en/quickstart.md) to run your first room.
```
spr/
├── soleprint/ # Core framework
│ ├── artery/ # Connectors (veins, shunts, pulses)
│ ├── atlas/ # Documentation (books, templates)
│ └── station/ # Tools (tester, datagen, modelgen)
├── cfg/ # Room configurations
├── init/ # Room setup (CLI + web wizard)
├── docs/ # Documentation site
├── ctrl/ # Build/deploy scripts
├── build.py # Build tool: cfg/ → gen/
└── gen/ # Built instances (gitignored)
```

6
docs/data/en/atlas.md
View File

@@ -31,10 +31,10 @@ Core books live in `soleprint/atlas/books/`. Room-specific books live in `cfg/<r
At build time, room-specific books are merged into the output: At build time, room-specific books are merged into the output:
``` ```
soleprint/atlas/books/ # Core books (all rooms) soleprint/atlas/books/ # Core books (all rooms)
cfg/amar/atlas/books/ # Amar-specific books cfg/<room>/atlas/books/ # Room-specific books
↓ build.py ↓ build.py
gen/amar/soleprint/atlas/books/ # Merged output gen/<room>/soleprint/atlas/books/ # Merged output
``` ```
Core books ship with every room. Room books add to or override them. The build copies the core first, then overlays the room-specific content. Core books ship with every room. Room books add to or override them. The build copies the core first, then overlays the room-specific content.

1
docs/data/en/concepts.md
View File

@@ -11,7 +11,6 @@ A room is an isolated configuration. Each room lives in `cfg/<room>/` and contai
``` ```
cfg/ cfg/
standalone/ # Soleprint only, no managed app standalone/ # Soleprint only, no managed app
amar/ # Soleprint wrapping the Amar application
myroom/ # Your room myroom/ # Your room
``` ```

2
docs/data/en/station-datagen.md
View File

@@ -28,7 +28,7 @@ Rooms subclass a base generator and provide domain-specific data factories:
```python ```python
from station.tools.datagen.base import BaseGenerator from station.tools.datagen.base import BaseGenerator
class AmarDataGenerator(BaseGenerator): class RoomDataGenerator(BaseGenerator):
def generate_customers(self, count=10): def generate_customers(self, count=10):
return [self.fake_customer() for _ in range(count)] return [self.fake_customer() for _ in range(count)]