Add ARCHITECTURE doc and MD markdownlint #122
Merged
Conversation
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
Signed-off-by: Zvonko Kaiser <zkaiser@nvidia.com>
Signed-off-by: Zvonko Kaiser <zkaiser@nvidia.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces comprehensive architecture documentation for a Micro VM Guest Execution Environment for Confidential Containers, along with markdown linting infrastructure to maintain documentation quality.
Changes:
- Added detailed ARCHITECTURE.md document describing security mechanisms, threat models, and implementation details for confidential containers
- Added markdown linting workflow to enforce documentation standards
- Added markdownlint configuration file
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs.yaml | GitHub Actions workflow for linting markdown files on push and pull requests |
| ARCHITECTURE.md | Comprehensive 1047-line architecture document covering security, formal verification, rootkits, and countermeasures for confidential containers |
| .markdownlint.json | Markdownlint configuration with 80-character line length limit and exceptions for code blocks and tables |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Zvonko Kaiser <zkaiser@nvidia.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add ARCHITECTURE doc and MD markdownlint