117 lines
3.1 KiB
Markdown
117 lines
3.1 KiB
Markdown
# ALBUM: Documentation System
|
|
|
|
## Purpose
|
|
Documentation, templates, and data. Composed into books.
|
|
|
|
### Book Types
|
|
|
|
**Single-larder book** (template: null)
|
|
- Book and larder are interchangeable
|
|
- Just static content served directly
|
|
- Listed in books.json, NOT in larders.json
|
|
|
|
**Templated book** (template: {...})
|
|
- Template defines the structure
|
|
- Larder must contain only elements matching that template
|
|
- Template validates/constrains the larder content
|
|
- Shows a styled landing page linking to template and larder
|
|
|
|
### Larders vs Books
|
|
|
|
- **Larders** = buckets that connect to other systems (e.g., drive, external data sources)
|
|
- **Books** = standalone content, may be single-larder or template+larder
|
|
- Single-larder books are listed as books, not larders
|
|
|
|
### Templated Book Structure
|
|
|
|
A templated book must contain a `template/` folder with the template definition inside:
|
|
|
|
```
|
|
book/{book-slug}/
|
|
├── template/ # REQUIRED for templated books
|
|
│ └── {template-files}
|
|
├── {larder-name}/ # The actual data (marked with .larder file)
|
|
│ └── .larder
|
|
├── index.html # Larder browser (used at /book/{slug}/larder/)
|
|
└── detail.html # Detail view template (if needed)
|
|
```
|
|
|
|
Example:
|
|
```
|
|
book/feature-form-samples/
|
|
├── template/ # Template definition
|
|
│ └── plantilla-flujo.md
|
|
├── feature-form/ # Larder data (constrained by template)
|
|
│ ├── .larder
|
|
│ ├── pet-owner/
|
|
│ ├── veterinarian/
|
|
│ └── backoffice/
|
|
├── index.html # Larder browser
|
|
└── detail.html # Detail renderer
|
|
```
|
|
|
|
Routes for templated books:
|
|
- `/book/{slug}/` → Landing page (template + larder links)
|
|
- `/book/{slug}/template/` → Template definition
|
|
- `/book/{slug}/larder/` → Larder browser
|
|
|
|
## Components
|
|
|
|
### Template (Patterns)
|
|
|
|
**Gherkin/BDD**
|
|
- Status: Pending
|
|
- Goal: .feature files, simple templates for non-tech
|
|
|
|
**Index Templates**
|
|
- Status: Pending
|
|
- Goal: HTML generators for indexes
|
|
|
|
### Vault (Data)
|
|
|
|
**drive/**
|
|
- Status: Downloaded
|
|
- Contents: Company drive (identity, marketing, ops, supply, finance, clients, pitches)
|
|
|
|
### Book (Composed Docs)
|
|
|
|
**drive-index**
|
|
- Status: Priority
|
|
- Goal: Two indexes (internal full, public privacy-conscious)
|
|
|
|
**flow-docs**
|
|
- Status: Pending
|
|
- Goal: User flow documentation (pet owner, vet, ops)
|
|
|
|
## Upward Report
|
|
```
|
|
ALBUM: Drive index priority. Template + vault → book composition defined.
|
|
```
|
|
|
|
## Priority
|
|
1. Drive index book (HTML from vault/drive)
|
|
2. One gherkin template example
|
|
3. Flow documentation structure
|
|
|
|
## Vault Contents (vault/drive)
|
|
- 01.Identidad Amar Mascotas
|
|
- 02. Marketing contenidos
|
|
- 03. Marketing Growth
|
|
- 05. ATC - Operaciones
|
|
- 06. Supply (vetes-labo-clinicas)
|
|
- 07. Finanzas y contabilidad
|
|
- Clientes - ventas - devoluciones
|
|
- Pitch Decks - Presentaciones
|
|
|
|
## Deployment
|
|
|
|
- **URL**: https://album.mcrn.ar
|
|
- **Port**: 12002
|
|
- **Service**: `systemctl status album`
|
|
|
|
FastAPI app serving documentation. Currently serves index.html at root, expandable for book browsing.
|
|
|
|
## Upstream (for main pawprint thread)
|
|
|
|
This is now a separate repo. See pawprint/UPSTREAM.md for merge notes.
|