pygienium/tasks/14-readme-help-integration.md

14. README, help text, and end-to-end integration

meta: id: pygienium-14 feature: pygienium priority: P2 depends_on: [pygienium-12, pygienium-13] tags: [docs, integration]

objective:

• Author the README and full help text, then run an end-to-end integration pass over the whole extension to verify all commands, the registry extensibility claim, and the exit criteria.

deliverables:

• pygienium/README.md: what it is, install, commands, flags, how to add a check (one file + registerCheck)
• src/help.ts fully populated: per-command usage/does/example + CLI flag help, mirroring piolium's help.ts
• /pygienium-help renders the full help block
• Extensibility verification: add a new check in checks/ + one registry line with NO index.ts command changes; confirm a new /pygienium-<new> command appears

steps:

• Write README sections: overview, the five checks, commands, flags, adding a check, architecture (sub-agent loops)
• Populate help.ts COMMANDS + CLI_FLAGS arrays from the actual commands/flags implemented in 06-13
• Extensibility test: create checks/noop.ts registering registerCheck({name:"noop",...}), reload, confirm /pygienium-noop exists and /pygienium-help lists it
• Run /pygienium-all end-to-end on this repo and confirm the exit criteria

tests:

• Integration: /pygienium-help lists all 8+ commands and all flags
• Integration: a newly registered check auto-creates its command without index.ts edits
• Integration: /pygienium-all completes with all checks marked complete

acceptance_criteria:

• README documents install, commands, flags, and the one-file extensibility workflow
• /pygienium-help output matches the implemented commands/flags exactly
• A new check file + registerCheck entry yields a working /pygienium-<name> command with zero index.ts changes
• All exit criteria from the feature README pass

validation:

• pi -p "/pygienium-help" prints the full help
• Add the noop check, /reload, run /pygienium-noop, confirm success
• Run /pygienium-all and inspect the final summary

notes:

• This is the acceptance gate for the whole feature
• If the extensibility claim fails here, refactor the registry in task 06 before declaring done