Add peripheral documentation gap analysis #323
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Identifies peripheral driver classes missing or with incomplete documentation in
doc/hardware/peripherals/by comparing against headers ininclude/zephyr/drivers/.Findings
21 peripherals with no documentation:
cellular, disk, espi_saf, ethernet, firmware, fpga, ieee802154, interrupt_controller, led_strip, memc, mfd, mic_privacy, mipi_dbi, mipi_dsi, modem, pm_cpu_ops, power, sip_svc, swdp, syscon, tee
8 peripherals with stub docs (API ref only, ~13 lines):
adc, counter, i2c_eeprom_target, ipm, pcie, pwm, spi, watchdog
11 peripherals with incomplete docs (<25 lines):
bbram, clock_control, crc, dac, entropy, hwspinlock, mbox, mdio, psi5, sent, tgpio
Document also notes peripherals documented elsewhere (bluetooth→
connectivity/bluetooth/, usb→connectivity/usb/, etc.) and references well-documented peripherals like gpio.rst (153 lines) as templates.Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.