Add project documentation mdBook - #39
Merged
philgweber merged 2 commits intoAug 20, 2026
Merged
Conversation
Create a project-owned mdBook per RFC 0044 and migrate the EC interface specification from the centralized documentation repository. Add local build guidance and GitHub Pages publishing. Assisted-by: GitHub Copilot:gpt-5.6-sol Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
philgweber
requested review from
jerrysxie,
kat-perez,
maxperga-msft,
rogurr and
williampMSFT
and
a lite review from Copilot
August 20, 2026 16:14
There was a problem hiding this comment.
Pull request overview
This PR introduces project-level documentation as an mdBook (per ODP RFC 0044), migrates the Embedded Controller Interface specification content into that book, and adds GitHub Actions automation to build and publish the book to GitHub Pages on main.
Changes:
- Add an mdBook under
docs/with navigation (SUMMARY.md) and introductory/development content. - Import the EC interface specification Markdown (and reference media) into
docs/src/specs/ec_interface/. - Add a GitHub Actions workflow to build the book and deploy it to GitHub Pages, plus ignore the generated
docs/book/output.
Reviewed changes
Copilot reviewed 23 out of 40 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds documentation section and local build instructions |
| docs/README.md | Documents mdBook usage and provenance of migrated spec |
| docs/book.toml | mdBook configuration (title, output dir, edit links) |
| docs/src/SUMMARY.md | Defines mdBook navigation structure |
| docs/src/introduction.md | Book introduction and project context |
| docs/src/development.md | Pointers to development process docs |
| docs/src/supply-chain.md | Adds supply-chain / cargo-vet guidance to the book |
| docs/src/specs/specifications.md | Specs landing page for the book |
| docs/src/specs/ec_interface/ec_interface.md | EC interface spec entry point |
| docs/src/specs/ec_interface/ec-soc-interface.md | EC SoC interface spec section |
| docs/src/specs/ec_interface/legacy-ec-interface.md | Legacy EC interface specification text |
| docs/src/specs/ec_interface/secure-ec-services-overview.md | Secure-world EC services overview spec |
| docs/src/specs/ec_interface/ec-firmware-management.md | Firmware management spec section |
| docs/src/specs/ec_interface/ec-power-service.md | Power service spec section |
| docs/src/specs/ec_interface/battery-service.md | Battery service spec section |
| docs/src/specs/ec_interface/thermal-service.md | Thermal service spec section |
| docs/src/specs/ec_interface/ucsi-interface.md | UCSI interface spec section |
| docs/src/specs/ec_interface/ec-input-management.md | Input management spec section |
| docs/src/specs/ec_interface/ec-time-alarm-service.md | Time/alarm service spec section |
| docs/src/specs/ec_interface/ec-debug-service.md | Debug service spec section |
| docs/src/specs/ec_interface/ec-manufacturing-service.md | Manufacturing service spec section |
| docs/src/specs/ec_interface/ec-oem-service.md | OEM service spec section |
| docs/src/specs/ec_interface/sample-system-implementation.md | Sample system implementation appendix |
| .github/workflows/docs.yml | Adds mdBook build + Pages deployment workflow |
| .gitignore | Ignores generated docs/book/ output directory |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
kurtjd
previously approved these changes
Aug 20, 2026
kurtjd
left a comment
kurtjd
left a comment
Member
There was a problem hiding this comment.
There is some outdated info and typos, but I'm guessing that is out of scope for this PR, and this is just the initial transfer of some docs to this repo?
Contributor
Author
|
Let me at least fix the typos above. For the content this is primarily for FFA interface through ACPI to keep the documentation for that existing path. This was primarily to move the docs but I can update some of this content while I'm touching it anyways. |
Correct the spelling, code identifier, and Markdown fence issues found during review so the imported documentation renders and reads correctly. Assisted-by: GitHub Copilot:gpt-5.6-sol Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
kurtjd
approved these changes
Aug 20, 2026
felipebalbi
approved these changes
Aug 20, 2026
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.
Summary
Validation
mdbook build docsRelated issues