2cc766aabe
Port the sssf skill from ~/.agents/skills/sssf into this repo so it can be distributed and installed with the skills CLI (skills add INDigitalStudio/skills --skill sssf). - Copy the skill (SKILL.md, cookbooks, references, scripts, templates, and the visualizer app source) into sssf/. - Gitignore build/runtime artifacts: the visualizer's node_modules/ and dist/, Python bytecode, and the machine-specific repos.json. - Make the skill location-independent: install.py now stamps the skill's real path into the stamped justfile's skill_dir (replacing the hardcoded ~/.agents/skills/sssf), so 'just obs' finds the visualizer wherever the CLI installed the skill. - Update cookbooks to use <skill>/scripts/... instead of the hardcoded path, and document the skills CLI install command. - Update the repo README with install instructions.
48 lines
2.3 KiB
Markdown
48 lines
2.3 KiB
Markdown
# Document Task
|
|
|
|
## Variables
|
|
|
|
### prompt
|
|
|
|
{{prompt}}
|
|
|
|
### previous_envelope
|
|
|
|
{{previous_envelope}}
|
|
|
|
### context_handoff_dir
|
|
|
|
{{context_handoff_dir}}
|
|
|
|
## Task
|
|
|
|
Document the completed work described by `previous_envelope`, using `prompt` for what was originally asked.
|
|
|
|
1. Read the full diff at `previous_envelope.diff_path`, plus any changed file that needs context.
|
|
2. Write the write-up to `<context_handoff_dir>/document.md`. Cover: what changed and why it matters, the files that carry it, and how to use or verify it.
|
|
3. Copy that file into the repo under `app_docs/`:
|
|
- **List `app_docs/` before you pick the name.** A session that documents more than once reuses its `<adw_id>`, so the obvious name may already be taken.
|
|
- Base name: `app_docs/<adw_id>_<slug>.md`, where `<adw_id>` is the session directory name inside `context_handoff_dir` (`.../sessions/<adw_id>/context_handoff`) and `<slug>` is two to four kebab-case words naming the work.
|
|
- If a file with that name already exists, use `app_docs/<adw_id>_<slug>_v2.md`, then `_v3`, and so on until the name is free. **Never overwrite an existing write-up** — it describes a change that already shipped.
|
|
- **Copy it, do not retype it.** One bash call does the whole step:
|
|
`mkdir -p app_docs && cp "<context_handoff_dir>/document.md" "app_docs/<adw_id>_<slug>.md"`
|
|
Writing the document a second time through `write` re-emits every line you already wrote, which costs the whole write-up again in output tokens and lets the two copies drift.
|
|
4. Emit your `Report` JSON, declaring BOTH paths in `artifacts`.
|
|
|
|
## Report
|
|
|
|
Respond with ONLY valid JSON matching `DocumentOutput` — no prose before or after:
|
|
|
|
```json
|
|
{
|
|
"status": "success",
|
|
"summary": "<one sentence describing what you documented>",
|
|
"document_path": "app_docs/<adw_id>_<slug>.md",
|
|
"documented_files": ["src/server.ts"],
|
|
"artifacts": ["<context_handoff_dir>/document.md", "app_docs/<adw_id>_<slug>.md"],
|
|
"commit_message": "<imperative one-line git subject for committing THIS WRITE-UP, not the change it describes — e.g. 'Document the /health endpoint'>",
|
|
"notes_for_next_agent": "<anything the diff left unexplained>"
|
|
}
|
|
```
|
|
|
|
`document_path` and the `app_docs/` entry in `artifacts` are the path you ACTUALLY wrote, `_v2` suffix and all. Gates open these files — a name you meant to use fails them.
|