docs + chore(workplan): complete T06 and T07 for CYA-WP-0004 — final documentation polish and packaging debt registration

This commit is contained in:
2026-05-27 00:18:39 +02:00
parent 69de28b1fe
commit c0039c293a
3 changed files with 68 additions and 57 deletions

View File

@@ -167,11 +167,19 @@ First useful worker moves:
## Commands
```bash
# Recommended: Install from latest development code
# === Packaging & Installation (CYA-WP-0004) ===
# Recommended: Stay on latest development code
make dev-install
# Or manually:
# pip install -e ".[dev]"
# Build distribution packages (sdist + wheel)
make dist
# Prepare a release (tests + clean build)
make release-prep
# Verify a built wheel in isolation
make check-dist
# Run the assistant
cya "your natural language request here"
@@ -179,17 +187,12 @@ cya --help
cya --explain-context "show me what context would be collected"
# Memory features (0003)
cya retrospect # Guided reflection session to set goals & preferences
cya --explain-context "..." # See exactly which memory was activated (including from retrospection)
cya retrospect # Guided reflection session
# Memory is user-controlled and scoped
# Backing files: ~/.config/cya/memory/<scope>.json (plain JSON, fully editable)
cya "remember that I always want --short --branch on git status"
# Tests (safety + memory + activation + retrospection)
# Tests
python -m pytest tests/ -q
# Git / inspection (always useful)
# Git / inspection
git status --short
git log --oneline -5
rg --files
@@ -201,7 +204,8 @@ Current primary entry point: `cya` (after editable install).
Relevant workplans:
- `workplans/CYA-WP-0002-memory-integration-roadmap.md`
- `workplans/CYA-WP-0003-contextual-memory-activation-and-retrospection.md` (current)
- `workplans/CYA-WP-0003-contextual-memory-activation-and-retrospection.md`
- `workplans/CYA-WP-0004-dev-install-and-release-packaging.md` (current)
## Workplan Convention