mirror of
https://github.com/Gathin23/cleanyourtv.git
synced 2026-11-06 21:16:38 +00:00
Gathin23
ba84e8f8c4
CONTRIBUTING.md, the tv-list workflow, AGENTS.md and the PR template ask for examples/<folder>/tv.json instead of README rows, and say to change nothing outside the folder. MAINTAINER.md: a missing tv.json is the merge-with-fix, rows from older PRs are dropped on merge (--adopt keeps them as tv.json), the maintainer runs tools/gen_tables.py after merging, and a README-only conflict needs no rebase.
17 lines
1.1 KiB
Markdown
17 lines
1.1 KiB
Markdown
# 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 gets its `tv.json` (the TV tables are generated from it), and a
|
|
theme, add-on or tool its row where the others are.
|
|
|
|
Then run the tests: `python3 -m unittest discover -s tests -v`.
|