Repository navigation
Build the wolfCOSE manual with the shared documentation tooling - #91
Open
aidangarske wants to merge 1 commit into
Open
aidangarske wants to merge 1 commit into
aidangarske wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
PDF heading namespacing breaks existing same-page navigation links.
Review effort: Balanced
Findings: 1
Open (1)
What changed in this PR
Migrates wolfCOSE’s manual from a GitHub wiki mirror to HTML and PDF builds using shared wolfSSL documentation tooling.
Changes:
- Establishes
docs/and MkDocs navigation as the manual source. - Adds a build adapter, container image, and CI artifacts.
- Replaces wiki links and documents local builds and publishing.
| File | Description |
|---|---|
| tools/docs-manual/Makefile | Integrates shared build rules. |
| tools/docs-manual/documentation-rev | Pins shared tooling revision. |
| tools/docs_manual.py | Stages pages and rewrites PDF anchors. |
| tools/check-docs-no-internal-links.sh | Checks for internal references. |
| README.md | Links to the official manual. |
| mkdocs.yml | Defines navigation and site configuration. |
| docs/Testing.md | Converts links and removes a badge. |
| docs/Release-Notes.md | Converts wiki links. |
| docs/README.md | Removes wiki-maintenance instructions. |
| docs/PSA-EAT.md | Converts a wiki link. |
| docs/Project-Structure.md | Converts wiki links. |
| docs/MISRA-Compliance.md | Converts a wiki link. |
| docs/Message-Types.md | Converts wiki links. |
| docs/Macros.md | Updates links and arrow notation. |
| docs/index.md | Replaces the wiki landing page. |
| docs/Getting-Started.md | Updates links and a section target. |
| docs/Footprint.md | Converts wiki links. |
| docs/dev/DOCS-BUILD.md | Documents builds and publishing. |
| docs/assets/skin.css | Adds manual styling. |
| docs/API-Reference.md | Converts wiki links. |
| docs/Algorithms.md | Converts wiki links. |
| docs/_Sidebar.md | Removes wiki navigation. |
| docker/docs/requirements.txt | Pins MkDocs. |
| docker/docs/Dockerfile | Adds the documentation builder image. |
| .gitignore | Excludes generated build output. |
| .github/workflows/wiki-sync.yml | Removes wiki publishing. |
| .github/workflows/publish-docs-image.yml | Publishes the builder image. |
| .github/workflows/misra-2023.yml | Updates a documentation comment only. |
| .github/workflows/docs-site.yml | Builds and uploads validated manual artifacts. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
aidangarske
force-pushed
the
docs/official-manual
branch
from
October 7, 2026 00:10
3fa706a to
b4e55e8
Compare
This branch has not been deployed
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.

and PDF.
URL.
artifact with strict mkdocs), and publish-docs-image.yml.
and a 103-page PDF; docs link guard and no-wiki grep clean.
wolfCOSE-Manual.pdf