Skip to content

Conversation

@moidx
Copy link
Collaborator

@moidx moidx commented Sep 28, 2025

Summary

This PR introduces automated GitHub Pages deployment for mdbook documentation and improves the overall documentation structure with better organization and Mermaid diagram support.

Changes

GitHub Pages Workflow

  • Add new github_pages.yml workflow for automated mdbook documentation deployment
  • Clean up docs.yml workflow by removing GitHub Pages deployment and redirect logic
  • Separate concerns: docs.yml now focuses solely on Rust API documentation validation
  • Use cargo xtask docs command to build mdbook documentation consistently
  • Deploy from target/book directory to GitHub Pages
  • Add manual workflow dispatch trigger for testing deployments

Documentation Structure

  • Update SUMMARY.md to include new specification and design document sections
  • Reorganize content with better categorization:
    • Specification documents (firmware resiliency, middleware, services)
    • Design documents (driver-hubris-hash, rust-trait-to-idl-conversion)
  • Improve navigation structure for better user experience

Mermaid Diagram Support

  • Fix Mermaid rendering issues by adding missing JavaScript dependencies
  • Add mermaid.min.js and mermaid-init.js to docs/src/third_party/
  • Update book.toml configuration to include Mermaid JavaScript files
  • Enable proper diagram rendering in mdbook documentation

md-book was not rendering mermaid diagrams due to missing javascript
dependencies. This change adds the javascript files under
`docs/src/third_party`.

Signed-off-by: Miguel Osorio <[email protected]>
Adds the following sections to md-book:

* Specification documents
* Design documents

Signed-off-by: Miguel Osorio <[email protected]>
- Add new github_pages.yml workflow for publishing mdbook docs
- Remove GitHub Pages deployment from docs.yml workflow
- Clean up docs.yml to focus on Rust API documentation only
- Use cargo xtask docs command to build mdbook documentation
- Deploy static files from target/book to GitHub Pages
- Separate concerns: docs.yml for API docs, github_pages.yml for site

Signed-off-by: Miguel Osorio <[email protected]>
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Sep 28, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

@moidx moidx closed this Sep 29, 2025
@moidx moidx reopened this Sep 29, 2025
@moidx moidx merged commit 1b0b17f into OpenPRoT:main Sep 29, 2025
13 checks passed
@moidx moidx deleted the githubio branch September 29, 2025 19:08
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