Skip to content

Documentation overhaul#387

Merged
AlexLanzano merged 5 commits into
wolfSSL:mainfrom
bigbrett:docs-v2
May 29, 2026
Merged

Documentation overhaul#387
AlexLanzano merged 5 commits into
wolfSSL:mainfrom
bigbrett:docs-v2

Conversation

@bigbrett
Copy link
Copy Markdown
Contributor

@bigbrett bigbrett commented May 29, 2026

Refactors docs into a better layout and completes numerous missing sections.

Requires companion PR wolfSSL/documentation#266 for proper rendering of the web and PDF manual - this PR must be merged first

Rendered PDF: wolfHSM-Manual.pdf
HTML: wolfHSM-html.zip

Important note: Japanese docs are NOT touched by this and should still render properly. Eventually these should be migrated but that will understandably take time.

Copilot AI review requested due to automatic review settings May 29, 2026 15:22
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This documentation-only overhaul replaces the legacy chapter-based manual with a reorganized, feature-oriented documentation set and adds Doxygen coverage for the public SHE client API.

Changes:

  • Replaces chapter01.mdchapter09.md and appendix01.md with numbered topic files from overview through configuration/API references.
  • Adds detailed documentation for utilities, examples, integrations, configuration macros, and client/server API reference entry points.
  • Adds Doxygen comments for wolfhsm/wh_client_she.h.

Reviewed changes

Copilot reviewed 23 out of 24 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
wolfhsm/wh_client_she.h Adds Doxygen documentation for SHE client APIs.
docs/src/0-Index.md Adds new manual index.
docs/src/1-Overview.md Adds overview, features, and platforms.
docs/src/2-FAQs.md Adds FAQ content.
docs/src/3-Quickstart.md Adds client/server quickstart examples.
docs/src/4-Architecture.md Adds architecture and configuration overview.
docs/src/5-Features.md Adds consolidated feature documentation.
docs/src/6-Utilities.md Adds utility, benchmark, and test documentation.
docs/src/7-Examples.md Adds POSIX examples and demo client documentation.
docs/src/8-Integration.md Adds wolfSSL ecosystem integration notes.
docs/src/9-API-docs-client.md Adds client API reference index.
docs/src/10-API-docs-server.md Adds server API reference index.
docs/src/11-Configuration.md Adds configuration macro reference.
docs/draft/auth.md.bak Adds draft auth-manager backup notes.
docs/src/chapter01.md Removes legacy introduction chapter.
docs/src/chapter02.md Removes legacy overview chapter.
docs/src/chapter03.md Removes legacy getting-started chapter.
docs/src/chapter04.md Removes legacy internals chapter.
docs/src/chapter05.md Removes legacy client library chapter.
docs/src/chapter06.md Removes legacy server library chapter.
docs/src/chapter07.md Removes legacy customization chapter.
docs/src/chapter08.md Removes legacy porting chapter.
docs/src/chapter09.md Removes legacy auth-manager chapter.
docs/src/appendix01.md Removes legacy API appendix.

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

Comment thread docs/src/6-Utilities.md Outdated
Comment thread docs/src/6-Utilities.md Outdated
Comment thread docs/src/6-Utilities.md Outdated
Comment thread docs/draft/auth.md
Comment thread docs/src/1-Overview.md Outdated
Comment thread docs/src/2-FAQs.md
Comment thread docs/src/2-FAQs.md Outdated
Comment thread docs/src/4-Architecture.md Outdated
Comment thread docs/src/2-FAQs.md Outdated
@AlexLanzano AlexLanzano merged commit 570caf7 into wolfSSL:main May 29, 2026
108 checks passed
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.

3 participants