espressif/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-04-27 19:13:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(usb): Update links and example checks

Browse Source 
Replace the peripherals index USB entries with direct links to
ESP-USB so the generated pages are no longer redirect-only stubs.

Keep legacy USB URLs working via redirects, including the
individual USB host maintainer notes pages.

Remove the obsolete placeholder documents and stale CODEOWNERS
pattern.

Mark the moved USB examples as KNOWN_MISSING in the example
documentation checker until it can also read the ESP-USB guide.
This commit is contained in:
igor.masar
2026-03-02 23:20:19 +01:00
parent 7b38e47834
commit c30851292f
12 changed files with 33 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tools/ci/check_examples_documented.py
+13
View File
@@ -150,8 +150,21 @@ KNOWN_MISSING = {
'peripherals/spi_slave_hd/segment_mode/seg_slave',
'peripherals/twai/twai_network/twai_listen_only',
'peripherals/twai/twai_network/twai_sender',
# TODO: remove once the checker can also account for the ESP-USB programming guide.
'peripherals/usb/device/cherryusb_serial_device',
'peripherals/usb/device/tusb_composite_msc_serialdevice',
'peripherals/usb/device/tusb_console',
'peripherals/usb/device/tusb_hid',
'peripherals/usb/device/tusb_midi',
'peripherals/usb/device/tusb_msc',
'peripherals/usb/device/tusb_ncm',
'peripherals/usb/device/tusb_serial_device',
'peripherals/usb/host/cdc',
'peripherals/usb/host/cherryusb_host',
'peripherals/usb/host/hid',
'peripherals/usb/host/msc',
'peripherals/usb/host/usb_host_lib',
'peripherals/usb/host/uvc',
# TODO IDF-15383: add :example: references for protocols examples
'protocols/dns_over_https',
'protocols/http_request',