Repository navigation
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are reported for the documentation index update.
No open issues 🎉
What changed in this PR
Updates the wolfBoot documentation index to reflect the current documentation set after the earlier CMake documentation reorganization.
Changes:
- Removes the stale link to the deleted
STM32.md. - Adds eight missing entries covering platform support, attestation, SBOM generation, secure application handoff, Windows setup, and wolfHAL.
- Changes documentation navigation only; no runtime or build behavior changes.
| File | Description |
|---|---|
docs/README.md |
Removes the dead STM32 link and indexes eight existing documents with brief descriptions. |
Review effort: Balanced
dgarske
force-pushed
the
docs_index_stm32
branch
from
November 6, 2026 22:50
e9f91ee to
a26d78c
Compare
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
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
docs/README.mdstill linked todocs/STM32.md, which was removed in 1ad66e9 as a follow-up to the PR #598 review. In that review the STM32.md content was judged confusing and not actually STM32-specific (it mixed CMake, VS Code, Visual Studio and Windows toolchain notes and wrongly implied STM32 targets need CubeMX), so it was redistributed todocs/CMake.md,cmake/README.md,IDE/VSCode/README.mdanddocs/Windows.md. The index line was left behind. STM32 platform notes live indocs/Targets.mdanddocs/STM32-TZ.md, so nothing needs to be restored.This PR removes the dead link and adds index entries for the docs added since the index was created:
Agilex5.md,DICE.md,MCXN947-DICE.md,SBOM.md,Windows.md,fwTPM.md,secure_app_handoff.md,wolfHAL.md.Testing
Docs only, no code changes. Verified every
docs/*.mdhas exactly one index entry and every linked file exists.