mirror of
https://github.com/Gathin23/cleanyourtv.git
synced 2026-10-28 19:55:15 +00:00
xbsheng
95053a50f1
The bullets said where a new docs/devices/ note is linked from; the section they point at also says its model has no list of its own, and index_notes_with_their_own_list refuses an entry that links its own folder's debloat.txt. One test runs that checker over such a tree.
1.6 KiB
1.6 KiB
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. - A note in
docs/devices/is linked from a page a reader comes through: the row for its folder inexamples/README.mdwhen the model has a list of its own, and the "Notes for models that have no tested list yet" section of that page when it has not.tests/test_device_notes_index.pyfails on a note nothing links, which is how three of them were found sitting unread. That section is a claim as well: an entry filed there says its model has no list, so once the list lands the link moves into the row, whereindex_notes_with_their_own_listwants it. - 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 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.