Zephyr Documentation BoF
summary
Updates report concrete changes and open problems: documentation adds Sphinx sample metadata so samples link to API pages, search uses Google Programmable Search paid by the project and returns about 200 weekday queries, and esp32 ranking fourth appears in query stats. Ongoing work covers surfacing per‑board/SoC feature lists, considering Hardware Model v2 and autogenerated support tags, reconciling Doxygen vs rst API text, improving consistency and image tooling, and deciding whether bot or infra helpers should index docs and Discord to answer common questions.
AI-written summary · about
chapters (14)
- 0:00Zephyr Documentation BoF intro
- 1:28Recent Zephyr docs improvements
- 4:36Subsystem docs challenges
- 6:44Search and user feedback
- 9:15Docs quality consistency
- 11:28Docs pain points discussion
- 22:09External docs inspiration
- 26:51Docs infrastructure future
- 29:45API docs and Doxygen
- 31:56Embedded dev guides
- 34:08Docs authorship clarity
- 37:05Board feature documentation and DTS challenges
- 41:01Autogenerating board feature documentation
- 42:46Q&A
related talks
43mZephyr Documentation BoF
21mBuilding the Traceability for Design and Testing in Zephyr
29mIntroduction to Sphinx & Read the Docs
31mA Zephyr User Story
36mHow to Get Your Zephyr Patches Merged
27mZephyr and You: A Developer Environment for Newcomers
25mGraphQL Docs: Beyond the Schema
45mIntroduction to Sphinx & Read the Docs