Skip to content

docs: add project mdBook - #91

Open
philgweber wants to merge 1 commit into
mainfrom
docs/secure-ec-mdbook
Open

docs: add project mdBook#91
philgweber wants to merge 1 commit into
mainfrom
docs/secure-ec-mdbook

Conversation

@philgweber

Copy link
Copy Markdown
Collaborator

This PR:

  • Establishes project-owned documentation in line with governance RFC 0044.
  • Migrates the Secure EC Services page into mdBook with Mermaid diagrams.
  • Adds PR validation and main-branch GitHub Pages deployment.
  • Adds a README discovery link.
  • A coordinated removal PR will follow.

Closes OpenDevicePartnership/pfd-devops#218

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>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread docs/src/secure_ec_services.md
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