docs: add Secure EC overview - #40
Merged
jerrysxie merged 2 commits intoAug 28, 2026
Merged
Conversation
Document the project's goals, architecture, security direction, and key repositories in the mdBook. Link the overview from the README and fix existing Markdown lint issues. Assisted-by: GitHub Copilot:gpt-5.3-codex
jerrysxie
requested review from
RobertZ2011,
dhillonk,
felipebalbi,
kurtjd,
philgweber,
tullom and
williampMSFT
August 24, 2026 22:48
jerrysxie
commented
Aug 24, 2026
There was a problem hiding this comment.
Pull request overview
Adds a Secure EC project overview to the mdBook and links it from the README.
Changes:
- Documents goals, architecture, security direction, current work, and repositories.
- Adds the overview to mdBook navigation.
- Updates README Markdown formatting.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description | Review comments |
|---|---|---|
README.md |
Links the Secure EC overview and fixes Markdown formatting. | Nit (3 votes): Qualify secure boot, device identity, and attestation as goals or planned capabilities. |
docs/src/SUMMARY.md |
Adds the overview to book navigation. | None. |
docs/src/secure-ec-overview.md |
Adds Secure EC project documentation. | Nits: Clarify subsystem interfaces (4 votes); make the RISC-V EC and ARM QEMU/Windows setup explicit (2 votes); hyphenate the compound modifier (2 votes). |
Suppressed comments (2)
docs/src/secure-ec-overview.md:7
- The
and focusingclause is grammatically attached to the platform (that is ... and focusing), which makes the platform—not device makers—the subject doing the focusing. Change it towhile focusingso the sentence expresses the intended benefit for device makers.
on a standardized platform that is secure by design and focusing on their unique value added.
docs/src/secure-ec-overview.md:51
- This sentence is missing the article “a” before “standardized HID communication protocol,” which makes the current-work item grammatically incomplete.
- Developing standardized HID communication protocol over eSPI and I3C transport with OS support.
💡 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 24, 2026
RobertZ2011
previously approved these changes
Aug 25, 2026
jerrysxie
commented
Aug 25, 2026
Clarify that security features are planned and improve the overview's architecture, virtual platform, and grammar descriptions. Assisted-by: GitHub Copilot:gpt-5.3-codex
philgweber
approved these changes
Aug 27, 2026
jerrysxie
enabled auto-merge (squash)
August 28, 2026 17:42
RobertZ2011
approved these changes
Aug 28, 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.
A streamlined secure EC overview