docs: developer_guides: add descriptive bullet points across all sections - #529
Merged
lgirdwood merged 1 commit intoSep 20, 2026
Merged
Conversation
…ions Audit and expand the Developer Guides landing page so that every pillar and subsection provides an annotated bulleted summary with rich technical context, cross-references, and hidden toctrees. Specifically: - Add bullet points for rimage, llext_modules, and sof_hostless_firmware under Firmware Packaging, Dynamic Modules & Subsystems. - Add bullet points for sof_linux_driver, topology2, topology, and setup-ktest-environment under Kernel & Host Driver Development. - Add bullet points for sof_imx_user_guide, sof_hostless_firmware, and sof_hardware_loopback_testing under Hardware & Platform Bringup. - Add bullet points for unit_tests, sof_hardware_loopback_testing, testbench, cmake, xtrun, and sof_fuzzing under Testing, Simulation & Toolchains. - Convert bare visible toctrees to :hidden: to avoid duplicate bare link lists beneath the descriptive bullets. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
lgirdwood
requested review from
deb-intel,
intelkevinputnam,
mmaka1 and
mwasko
as code owners
September 20, 2026 14:41
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
This PR audits and modernizes the Developer Guides portal landing page (
developer_guides/index.rst), ensuring every pillar and technical subsection follows the standardized design of descriptive bullet points with cross-references and hidden toctrees.Changes:
:ref:``rimage``,:ref:llext_modules, and:ref:``sof_hostless_firmware``. Set toctree to:hidden:`.:ref:``sof_linux_driver``,:ref:topology2,:ref:``topology``, and:ref:setup-ktest-environment. Set toctree to:hidden:.:ref:``sof_imx_user_guide``,:ref:sof_hostless_firmware, and:ref:``sof_hardware_loopback_testing``. Set toctree to:hidden:`.:ref:``unit_tests``,:ref:sof_hardware_loopback_testing,:ref:``testbench``,:ref:cmake,:ref:``xtrun``, and:ref:sof_fuzzing. Set toctree to:hidden:.:hidden:.Verification:
woke -c rules-woke.yaml: 0 findingssphinx-build -b html -W --keep-going: 0 warnings, 0 errorsSigned-off-by: Liam Girdwood liam.r.girdwood@linux.intel.com