Files
cleanyourtv/docs/workflows/docs-notes.md
T
simandClaude Opus 5.5 5865347dfc docs: AGENTS.md's recipes move to docs/workflows/, word for word
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]>
2026-10-23 13:43:21 +10:00

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.md is 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.md as one extra sentence, kept brand-neutral. Brand-specific knowledge goes in examples/ or docs/devices/. Changes to the safety rules themselves go to the maintainer.
  • Several tests pin facts in docs/devices/ notes, PROMPT.md and docs/TROUBLESHOOTING.md (the tests/test_*_note.py files). 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.