Skip to content

fix missing/desynced docs wolf(SSL|MQTT|HSM|TPM)#271

Open
sebastian-carpenter wants to merge 3 commits into
wolfSSL:masterfrom
sebastian-carpenter:wolfssl-docs-fix
Open

fix missing/desynced docs wolf(SSL|MQTT|HSM|TPM)#271
sebastian-carpenter wants to merge 3 commits into
wolfSSL:masterfrom
sebastian-carpenter:wolfssl-docs-fix

Conversation

@sebastian-carpenter

Copy link
Copy Markdown

wolfSSL

Two main issues are addressed for the wolfssl docs:

  • The nav bar for the html version did not reference: ML-KEM, ML-DSA, SLH-DSA, LMS/HSS, XMSS, or PUF. These algorithms could be searched for but their links were not present (they were orphans).
  • The pdf was missing a lot of docs:
    • Six were missing entirely: ML-KEM, ML-DSA, SLH-DSA, LMS/HSS, XMSS, and PUF.
    • Appendix B was missing 23 algorithms: CMAC, ECCSI, HMAC, MD2, MD4, MD5, PBKDF, PKCS7, PKCS11, Poly1305, RIPEMD, RSA, SAKKE, SHA, SrtpKdf, SRP.
    • Appendix C was missing: ASCON, KDF, OCSP, and SHA-3.
    • The wolfSM appendix was also missing.

Made some minor changes to the wolfSSL docs based on a quick search. Also updated the GPLv2 license references to GPLv3.

wolfMQTT

wolfMQTT had the socket appendix duplicated, changed it to be packet and then socket.

wolfHSM, wolfTPM

wolfHSM and wolfTPM do not seem to be out of sync but do follow a similar format.

all

Added notes in the wolfHSM, wolfTPM, wolfMQTT, and wolfSSL docs describing the relationship between the nav bar and the Makefile so they do not get out of sync again.

@sebastian-carpenter sebastian-carpenter self-assigned this Jul 9, 2026
Copilot AI review requested due to automatic review settings July 9, 2026 22:00

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.

Pull request overview

Updates the wolf* documentation build inputs to prevent MkDocs HTML navigation and generated PDF content from getting out of sync, and to restore missing wolfSSL API/algorithm content in the PDF output.

Changes:

  • Expanded wolfSSL MkDocs nav and PDF assembly lists to include previously-orphaned / missing algorithm and header-file documentation.
  • Added explicit “keep mkdocs.yml nav and Makefile cat lists in sync” notes across wolfSSL, wolfMQTT, wolfTPM, and wolfHSM.
  • Fixed a wolfMQTT PDF appendix duplication and made several targeted doc/link/reference corrections in wolfSSL chapters/appendices.

Reviewed changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
wolfTPM/mkdocs.yml Adds a note documenting nav vs PDF build (Makefile) sync expectations.
wolfTPM/Makefile Adds a note clarifying the hardcoded PDF cat list mirrors MkDocs nav.
wolfSSL/src/chapter14.md Updates licensing text (GPL reference) in English docs.
wolfSSL/src/chapter13.md Updates GPL reference in OpenSSL compatibility chapter.
wolfSSL/src/chapter11.md Updates GPL reference in tutorial conclusion.
wolfSSL/src/chapter10.md Fixes/updates several wolfCrypt API names in examples and text.
wolfSSL/src/chapter07.md Updates several RSA/cert generation API references in examples.
wolfSSL/src/chapter06.md Updates callback documentation details and corrects typos.
wolfSSL/src/chapter05.md Corrects extern declaration and updates header reference.
wolfSSL/src/chapter04.md Fixes API names/links and updates PQC appendix reference.
wolfSSL/src/chapter03.md Adjusts file path references and benchmark variable naming.
wolfSSL/src/chapter02.md Fixes multiple option references/links and minor doc corrections.
wolfSSL/src/appendix06.md Escapes table cell content to prevent Markdown table breakage.
wolfSSL/mkdocs.yml Adds missing nav entries for algorithms and header files; fixes minor naming/spacing.
wolfSSL/Makefile Extends PDF appendices and updates PDF assembly cat lists for missing content.
wolfMQTT/mkdocs.yml Adds a note documenting nav vs PDF build (Makefile) sync expectations.
wolfMQTT/Makefile Fixes duplicated socket appendix in PDF assembly, switching to packet+socket.
wolfHSM/mkdocs.yml Adds a note documenting nav vs PDF build (Makefile) sync expectations.
wolfHSM/Makefile Adds a note clarifying hardcoded PDF cat lists mirror MkDocs nav.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread wolfSSL/src/chapter10.md Outdated
Comment thread wolfSSL/src/chapter10.md
Comment thread wolfSSL/src/chapter10.md Outdated
Comment thread wolfSSL/src/chapter10.md
Comment thread wolfSSL/src/chapter07.md Outdated
Comment thread wolfSSL/src/chapter14.md
@sebastian-carpenter sebastian-carpenter changed the title docs fix wolf(SSL|MQTT|HSM|TPM) fix missing/desynced docs wolf(SSL|MQTT|HSM|TPM) Jul 10, 2026
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.

2 participants