Documentation overhaul#387
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
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.md–chapter09.mdandappendix01.mdwith 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.
AlexLanzano
approved these changes
May 29, 2026
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.
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.