updated docs
This commit is contained in:
52
docs/data/en/intro.md
Normal file
52
docs/data/en/intro.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# Introduction
|
||||
|
||||
Soleprint is a development workflow platform. It wraps existing applications without touching their source code.
|
||||
|
||||
You get a sidebar injected into your app, connectors to external services, a test runner, data generators, and documentation tools. All running alongside your app, not inside it.
|
||||
|
||||
**Cada paso deja huella** — each step leaves a mark.
|
||||
|
||||
---
|
||||
|
||||
## Why It Exists
|
||||
|
||||
Born from freelance friction. Testing required PRs. Documentation was scattered across wikis and READMEs. Quick API connectors took too long to set up. Every project reinvented the same plumbing.
|
||||
|
||||
Soleprint is the control room that sits next to your app. You build once, reuse everywhere.
|
||||
|
||||
## How It Works
|
||||
|
||||
Soleprint runs as a Docker composition alongside your application. Nginx intercepts the app's HTML response and injects a sidebar via `sub_filter`. The sidebar connects to soleprint's backend, which bridges into the app's database through link adapters.
|
||||
|
||||
Your app stays untouched. No SDK. No middleware. No source changes.
|
||||
|
||||
## The Four Systems
|
||||
|
||||
| System | Purpose |
|
||||
|--------|---------|
|
||||
| **Artery** | Connectors to external services — Jira, Slack, Google, or your own APIs |
|
||||
| **Atlas** | Actionable documentation — books, templates, depots |
|
||||
| **Station** | Tools and execution — tester, datagen, modelgen, graphgen, databrowse |
|
||||
| **Soleprint** | Core coordinator — ties the systems together |
|
||||
|
||||

|
||||
|
||||
## Artery Hierarchy
|
||||
|
||||
Connectors scale from simple to full:
|
||||
|
||||
- **Vein** — stateless API connector
|
||||
- **Shunt** — fake connector for testing
|
||||
- **Pulse** — composed: vein + room + depot
|
||||
- **Plexus** — full app: backend + frontend + database
|
||||
|
||||
## What You Get
|
||||
|
||||
- Sidebar injection into any web app
|
||||
- BDD test runner with Gherkin support
|
||||
- Test data generation with faker
|
||||
- Model generation from schema
|
||||
- Interactive data browser
|
||||
- Navigable model graphs
|
||||
- Reusable API connectors with mock equivalents
|
||||
- Documentation that lives next to the code it describes
|
||||
Reference in New Issue
Block a user