docs: add project mdBook - #91
Open
philgweber wants to merge 1 commit into
Open
Conversation
Migrate the Secure EC Services documentation into a project-owned mdBook with Mermaid diagrams and repository discovery updates. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
philgweber
requested review from
kat-perez,
maxperga-msft,
rogurr and
williampMSFT
August 20, 2026 21:30
kurtjd
approved these changes
Aug 20, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces project-owned documentation using mdBook (with Mermaid diagrams) and adds GitHub Actions automation to build and deploy the docs to GitHub Pages, with a README link for discovery.
Changes:
- Add an mdBook documentation site scaffold (book config, SUMMARY, and initial “Secure EC Services” page with a Mermaid diagram).
- Add a GitHub Actions workflow to build mdBook on PRs and deploy to GitHub Pages on pushes to
main. - Add a README “Documentation” section and ignore the generated
docs/book/output.
Reviewed changes
Copilot reviewed 6 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds a discovery link pointing readers to the mdBook source. |
| docs/src/SUMMARY.md | Defines the mdBook table of contents. |
| docs/src/secure_ec_services.md | Adds initial documentation page with Mermaid diagram content. |
| docs/mermaid-init.js | Initializes Mermaid and handles theme switching behavior. |
| docs/book.toml | Configures mdBook build/output and Mermaid preprocessor integration. |
| .gitignore | Ignores generated mdBook output directory (docs/book/). |
| .github/workflows/docs.yml | Builds mdBook on PRs and deploys to GitHub Pages on main. |
Suppressed comments (1)
docs/src/secure_ec_services.md:19
- The diagram label uses “ARM/FFA” while the page text uses “FF-A”. Consider using “FF-A” here as well for consistency.
A1 -->|"Secure Path (ARM/FFA)"| B1
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
This PR:
Closes OpenDevicePartnership/pfd-devops#218