mirror of
https://github.com/Gathin23/cleanyourtv.git
synced 2026-11-07 21:26:41 +00:00
Each recipe becomes its own workflow file with a "When to use this" line and the test command at the end, as perf-ab.md does; AGENTS.md's Workflows section lists them all. Links into the old recipe anchors point at the new files. tests/test_agents_md.py now checks the paths each workflow names and that every workflow has its line in AGENTS.md. Co-Authored-By: Claude Opus 5.5 <[email protected]>
1017 B
1017 B
Workflow: Docs and troubleshooting notes
When to use this: a troubleshooting entry, a fix to PROMPT.md, or any other docs change.
docs/TROUBLESHOOTING.mdis grouped under headings (Connecting, Working on the TV, then one per larger problem). An entry is a bullet that opens with the symptom in bold, then the cause and the fix, naming the TV model and firmware it was seen on.- A fix for something your agent got stuck on usually belongs in
PROMPT.mdas one extra sentence, kept brand-neutral. Brand-specific knowledge goes inexamples/ordocs/devices/. Changes to the safety rules themselves go to the maintainer. - Several tests pin facts in
docs/devices/notes,PROMPT.mdanddocs/TROUBLESHOOTING.md(thetests/test_*_note.pyfiles). If you reword one of those passages, run the suite and keep the fact. - Docs and the README stay in step: a new list, theme, add-on or tool gets its row where the others are.
Then run the tests: python3 -m unittest discover -s tests -v.