Skip to content

Documentation cleanup: drop stale STM32.md index entry and add missing docs to docs/README.md - #977

Open
dgarske wants to merge 1 commit into
wolfSSL:masterfrom
dgarske:docs_index_stm32
Open

dgarske wants to merge 1 commit into
wolfSSL:masterfrom
dgarske:docs_index_stm32

Conversation

@dgarske

@dgarske dgarske commented Nov 6, 2026

Copy link
Copy Markdown
Member

Description

docs/README.md still linked to docs/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 to docs/CMake.md, cmake/README.md, IDE/VSCode/README.md and docs/Windows.md. The index line was left behind. STM32 platform notes live in docs/Targets.md and docs/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/*.md has exactly one index entry and every linked file exists.

@dgarske dgarske self-assigned this Nov 6, 2026
Copilot AI balanced review requested due to automatic review settings November 6, 2026 18:13
@dgarske dgarske assigned danielinux and unassigned dgarske Nov 6, 2026
@dgarske
dgarske requested a review from danielinux November 6, 2026 18:13

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants