Skip to content

Prepare wolfTrust documentation for public release - #31

Draft
aidangarske wants to merge 9 commits into
wolfSSL:mainfrom
aidangarske:docs/public-release
Draft

aidangarske wants to merge 9 commits into
wolfSSL:mainfrom
aidangarske:docs/public-release

Conversation

@aidangarske

@aidangarske aidangarske commented Sep 28, 2026 •

Copy link
Copy Markdown
Member
  • Make wolfTrust/docs the source for the HTML and PDF manual.any pr to wolftrust taht changes docs will auto update the documentation repo with no changes to the documentation repo needed. It will update nightly like other repos.
  • Separate FF-M and PSA compatibility claims and document their deviations.
  • Use HTTPS submodule URLs while retaining the current wolfHSM pin.
  • Build review artifacts with the shared wolfSSL documentation tools.

Current manual status: wolfTrust-Manual.pdf can also be viewed in the manual creation job on every pr to reivew the docs changes and rendering before merge

TODO:

@aidangarske aidangarske self-assigned this Sep 28, 2026
Copilot AI balanced review requested due to automatic review settings September 28, 2026 23:05

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Warning

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Copilot review overview

Review effort: Lite
Findings: 1 Medium severity

Open (1)
What changed in this PR

Prepares wolfTrust documentation for public release by switching from wiki-sync to a MkDocs/PDF manual built with shared wolfSSL/documentation tooling, and by reorganizing compatibility/claims documentation.

Changes:

  • Adds a manual build adapter (tools/docs_manual.py) plus pinned wolfSSL/documentation revision and Makefile glue.
  • Replaces TF-M compatibility doc with separated FF-M and PSA compatibility pages, adds standards/claims and footprint history.
  • Introduces Docker + GitHub Actions workflows to build/review HTML/PDF artifacts and publish a docs builder image.
File Description
tools/​docs_manual.py New Python adapter to stage docs into wolfSSL/documentation layout and validate/rewire PDF links.
tools/​docs-manual/​documentation-rev Pins the wolfSSL/documentation commit used by CI and local builds.
tools/​docs-manual/​Makefile Makefile shim consumed by shared documentation tooling targets.
tools/​check-docs-no-internal-links.sh Updates guard comment to reflect manual publishing.
mkdocs.yml Defines manual nav, metadata, and local MkDocs settings for docs source.
docs/​assets/​skin.css Adds manual styling to match public wolfSSL manuals.
docs/​assets/​architecture.mmd Adds Mermaid source for the architecture diagram.
docs/​assets/​architecture.config.json Mermaid rendering config for consistent diagram output.
docs/​_Sidebar.md Removes GitHub wiki sidebar (wiki sync removed).
docs/​Testing.md Updates CI trigger wording to match workflow configuration.
docs/​Targets.md Adds supported targets page (HW + emulator).
docs/​TF-M-Compatibility.md Removes combined TF-M compatibility page (superseded by FF-M/PSA pages).
docs/​Standards.md Adds standards/claims summary and pointers to deviation registers.
docs/​Services.md Clarifies storage WRITE_ONCE behavior; updates compatibility link to PSA page.
docs/​Security-Model.md Replaces relative source references with GitHub links.
docs/​Project-Structure.md Updates documentation/workflow descriptions for manual publishing.
docs/​Porting.md Removes Cortex-A aspirational text; updates docs publishing wording.
docs/​PSA-Compatibility.md Adds PSA compatibility register, deviations, and porting notes.
docs/​Macros.md Updates engine description wording for manual audience.
docs/​Home.md Adjusts overview and replaces embedded Mermaid with static diagram + PDF link.
docs/​Getting-Started.md Documents HTTPS submodule URLs and sync instructions.
docs/​Footprint-Comparison.md Adds dated footprint comparison methodology and reproduction notes.
docs/​FF-M-Compatibility.md Adds FF-M compatibility register, deviations, and validation boundary.
docs/​Crypto-Engines.md Updates references from TF-M page to footprint comparison page; wording clarifications.
docs/​Building.md Updates submodule URL guidance (HTTPS + sync).
docs/​Architecture.md Removes Cortex-A aspirational text; points to Porting boundary.
docs/​API-Reference.md Updates deviation references from TF-M page to PSA page; clarifies WRITE_ONCE behavior.
docker/​docs/​requirements.txt Pins MkDocs version for the docs builder image.
docker/​docs/​Dockerfile Adds container image for consistent HTML/PDF manual builds and CI.
README.md Updates overview text, VNET note, quickstart, and documentation pointers for manual.
DOCS-BUILD.md Adds local build instructions for the shared tooling and review artifacts.
.gitmodules Switches submodules to HTTPS (keeps wolfHSM pin + TODO note).
.github/​workflows/​wiki-sync.yml Removes wiki synchronization workflow.
.github/​workflows/​publish-docs-image.yml Adds workflow to publish docs builder image to GHCR.
.github/​workflows/​docs-site.yml Adds workflow to build and upload HTML/PDF artifacts for PRs/merges.
.github/​workflows/​README.md Documents new docs-site lane and updates trigger wording.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread DOCS-BUILD.md
@aidangarske

Copy link
Copy Markdown
Member Author

converting to draft till we get more feature complete then we can add detailed docs on the baseline

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