Ty
76df8b7ab6
Add owner-safe lesson catalog, fixture-backed capability statuses, CLI, and unit tests without live OAuth or connect scripts.
47 lines
1.6 KiB
Markdown
47 lines
1.6 KiB
Markdown
# `setup-education`
|
|
|
|
**Status:** Implemented (fixtures only).
|
|
|
|
Owner-safe connect education and capability report for use cases E1, E6, and E7.
|
|
|
|
## What it does
|
|
|
|
- **7 setup lessons** — step-by-step education for connecting the assistant
|
|
(name, profile, channels, scheduling, books, expectations, capability report)
|
|
- **Capability report** — plain-language summary of what is connected, offline,
|
|
skipped, or in error
|
|
- **Owner-safe** — all education text validated to never contain terminal,
|
|
docker, nano, or shell instructions
|
|
- **Fixture-labeled** — all demo data clearly marked `📋 FIXTURE DATA`
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
# Capability report (default demo data)
|
|
python skills/setup-education/scripts/build_capability_report.py
|
|
|
|
# JSON output
|
|
python skills/setup-education/scripts/build_capability_report.py --format json
|
|
|
|
# Show lesson 4 (connect scheduling)
|
|
python skills/setup-education/scripts/build_capability_report.py --lesson 4
|
|
|
|
# Show all lessons
|
|
python skills/setup-education/scripts/build_capability_report.py --all-lessons
|
|
```
|
|
|
|
## Fixtures
|
|
|
|
| File | Description |
|
|
|------|-------------|
|
|
| `data/fixtures/setup/capability_matrix.json` | Demo: mixed states (connected, offline, skipped, later) |
|
|
| `data/fixtures/setup/capability_matrix_all_connected.json` | Demo: all connected |
|
|
| `data/fixtures/setup/capability_matrix_with_errors.json` | Demo: includes error states |
|
|
|
|
## Design references
|
|
|
|
- Use case: [E1 — Educational setup](../../design/use-cases.md)
|
|
- Use case: [E6 — Capability report](../../design/use-cases.md)
|
|
- Use case: [E7 — Degraded mode](../../design/use-cases.md)
|
|
- Setup UX: [docs/SETUP_UX.md](../../docs/SETUP_UX.md)
|