|
| 1 | +# capiscio-docs - GitHub Copilot Instructions |
| 2 | + |
| 3 | +## ABSOLUTE RULES - NO EXCEPTIONS |
| 4 | + |
| 5 | +### 1. ALL WORK VIA PULL REQUESTS |
| 6 | +- **NEVER commit directly to `main`.** All changes MUST go through PRs. |
| 7 | + |
| 8 | +### 2. RFCs ARE READ-ONLY |
| 9 | +- **DO NOT modify RFCs** — they live in `capiscio-rfcs/`, not here. |
| 10 | + |
| 11 | +### 3. NO WATCH/BLOCKING COMMANDS |
| 12 | +- **NEVER run blocking commands** without timeout |
| 13 | + |
| 14 | +--- |
| 15 | + |
| 16 | +## CRITICAL: Read First |
| 17 | + |
| 18 | +**Before starting work, read the workspace context files:** |
| 19 | +1. `../../.context/CURRENT_SPRINT.md` - Sprint goals and priorities |
| 20 | +2. `../../.context/ACTIVE_TASKS.md` - Active tasks |
| 21 | + |
| 22 | +--- |
| 23 | + |
| 24 | +## Repository Purpose |
| 25 | + |
| 26 | +**capiscio-docs** is the unified public documentation site for CapiscIO, published via MkDocs at docs.capisc.io. |
| 27 | + |
| 28 | +It aggregates docs from multiple repos into a single site. |
| 29 | + |
| 30 | +**Technology Stack**: MkDocs (Material theme), Python, Markdown |
| 31 | + |
| 32 | +**Default Branch:** `main` |
| 33 | + |
| 34 | +## Structure |
| 35 | + |
| 36 | +``` |
| 37 | +capiscio-docs/ |
| 38 | +├── mkdocs.yml # MkDocs configuration (nav, theme, plugins) |
| 39 | +├── requirements-docs.txt # Python deps (mkdocs, material, plugins) |
| 40 | +├── docs/ |
| 41 | +│ ├── index.md # Landing page |
| 42 | +│ ├── getting-started/ # Quickstart, installation |
| 43 | +│ ├── how-to/ # Task-oriented guides (integrations, middleware) |
| 44 | +│ ├── reference/ # API reference (SDK, CLI, server) |
| 45 | +│ ├── concepts/ # Architecture, trust model, DID |
| 46 | +│ └── rfcs/ # RFC summaries (detail in capiscio-rfcs) |
| 47 | +├── scripts/ # Build/sync scripts |
| 48 | +└── site/ # Generated output (gitignored) |
| 49 | +``` |
| 50 | + |
| 51 | +## Quick Commands |
| 52 | + |
| 53 | +```bash |
| 54 | +pip install -r requirements-docs.txt # Install deps |
| 55 | +mkdocs serve # Dev server (localhost:8000) |
| 56 | +mkdocs build # Build static site |
| 57 | +make serve # Alias for mkdocs serve |
| 58 | +``` |
| 59 | + |
| 60 | +## Documentation Standards |
| 61 | + |
| 62 | +- **Diataxis framework**: tutorials → how-to → reference → concepts |
| 63 | +- **Cross-repo accuracy**: Docs must match actual SDK/server/core APIs |
| 64 | +- Use `admonitions` for warnings/notes: `!!! warning`, `!!! note` |
| 65 | +- Code examples must be tested or derived from actual working code |
| 66 | +- When documenting SDK APIs, verify against `capiscio-sdk-python` source |
| 67 | +- When documenting server APIs, verify against `capiscio-server` swagger |
| 68 | +- Internal docs go in `internal-docs/` (workspace root), NOT here |
0 commit comments