Skip to content

Build the wolfCOSE manual with the shared documentation tooling - #91

Open
aidangarske wants to merge 1 commit into
wolfSSL:mainfrom
aidangarske:docs/official-manual
Open

aidangarske wants to merge 1 commit into
wolfSSL:mainfrom
aidangarske:docs/official-manual

Conversation

@aidangarske

Copy link
Copy Markdown
Member
  • docs/ becomes the single manual source; mkdocs.yml defines the navigation; the shared wolfSSL/documentation tooling renders HTML
    and PDF.
  • Replaces the GitHub wiki mirror: removes wiki-sync.yml, _Sidebar.md, and docs/README.md; Home.md becomes index.md.
  • Converts all wiki [[links]] to relative .md links; README and the misra-2023 workflow point at docs/ and the official manual
    URL.
  • Adds the build adapter tools/docs_manual.py, the docker/docs builder image, DOCS-BUILD.md, docs-site.yml (per-PR HTML and PDF
    artifact with strict mkdocs), and publish-docs-image.yml.
  • docs-site.yml pins the documentation revision via tools/docs-manual/documentation-rev.
  • The PDF adapter de-duplicates repeated heading anchors so per-release Release Notes subsections render.
  • Companion documentation integration adds the nightly wolfcose target; merge this PR first since that build reads wolfCOSE main.
  • Testing: full HTML and PDF build on a Linux box via docker/docs (mkdocs --strict plus pandoc/xelatex) produced a 14-page site
    and a 103-page PDF; docs link guard and no-wiki grep clean.

wolfCOSE-Manual.pdf

@aidangarske aidangarske self-assigned this Oct 6, 2026
Copilot AI balanced review requested due to automatic review settings October 6, 2026 23:23

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.

Copilot review overview

🟡 Changes recommended

PDF heading namespacing breaks existing same-page navigation links.

Review effort: Balanced
Findings: 1 Medium severity

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.

Comment thread tools/docs_manual.py

This branch has not been deployed

No deployments
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