Zephyr Documentation BoF
summary
Zephyr documentation now embeds Google Programmable Search (deployed late 2023) to replace Sphinx ranking, costing a few hundred dollars a month and serving about 200 weekday queries, and the docs add Sphinx sample metadata so samples link to API pages (example: PS2 sample surfaces from API reference). Work focuses next on surfacing per-board/SoC capabilities, deciding whether to keep or replace manual lists versus autogenerated board support, and on consistency, image tooling, and API vs. rst/doxygen divergence.
AI-written summary · about
chapters (15)
- 0:00Zephyr Documentation BoF intro
- 1:28Recent Zephyr docs improvements
- 3:57Navigation with metadata and samples
- 5:46Dependency and bloat concerns
- 6:49Upgrading search with Google
- 8:56Documentation consistency challenges
- 10:46Images and templating in docs
- 13:48Open discussion on docs pain points
- 22:09Improving board support docs
- 27:12Learning from other projects
- 29:20API docs and Doxygen integration
- 31:51Structured guide for beginners
- 33:54Authorship and audience clarity
- 37:08Autogenerating board feature docs
- 41:01Final discussion and next steps
related talks
43mZephyr Documentation BoF
21mBuilding the Traceability for Design and Testing in Zephyr
31mA Zephyr User Story
29mIntroduction to Sphinx & Read the Docs
37mZephyr Onboarding in 30 Seconds - Methods and Experiments During Zephyr Training
33mWrite the Docs!
46mZephyr Workbench: Open Source Zephyr Extension for VSCode
27mZephyr and You: A Developer Environment for Newcomers