Filing this as an enhancement, but feel free to flag as a bug. Several samples in the samples/ folder are missing a README.
Per our "Sample definition and criteria":
Samples must have a README.rst file in the samples folder. Example: samples/subsys/foo/README.rst. clearly explaining the purpose of the sample, its HW requirements, and the expected sample output, if applicable.
See the list below.
Note that there's a few false positives, for samples that are more "modular", but even those probably need to be reviewed as some have some form of README, but not one that's properly mounted in the table of contents on the website (ex. recently added sample for Thrift support, poke @cfriedt).
Do folks have thoughts/suggestions on how to best proceed? I can work on a PR addressing some of the trivial fixes from the list.
BTW there are some really old samples that should probably be removed altogether, ex. "thermometer" which is IMO essentialy useless/redundant now: https://github.com/zephyrproject-rtos/zephyr/tree/main/samples/sensor/thermometer
Filing this as an enhancement, but feel free to flag as a bug. Several samples in the
samples/
folder are missing a README. Per our "Sample definition and criteria":See the list below. Note that there's a few false positives, for samples that are more "modular", but even those probably need to be reviewed as some have some form of README, but not one that's properly mounted in the table of contents on the website (ex. recently added sample for Thrift support, poke @cfriedt).
Note that some of these samples actually have README or README.txt file so fixing these should be trivial.
Do folks have thoughts/suggestions on how to best proceed? I can work on a PR addressing some of the trivial fixes from the list. BTW there are some really old samples that should probably be removed altogether, ex. "thermometer" which is IMO essentialy useless/redundant now: https://github.com/zephyrproject-rtos/zephyr/tree/main/samples/sensor/thermometer