microsoft / microsoft/VbsEnclaveTooling
Add READMEs for Published Rust Crates and Update Repository Documentation
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 28
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
Now that the Rust crates have been published to crates.io, we should ensure that each published crate includes a README. At the moment, several crates do not provide any usage guidance or context on crates.io, which makes it difficult for users to understand how (or if) they should be used.
For example:
These crates currently do not display READMEs explaining their purpose, intended usage, or whether they are helper/internal crates versus user-facing APIs.
In addition, the top-level repository README should be updated to reflect the current state of the project and to make it easier for new contributors and users to:
- Build and use the EDL code generation tooling
- Build and use the SDK from both C++ and Rust
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the published Rust crates, including vbsenclave-sdk-enclave and vbsenclave-sdk-host, then read the top-level repository README to identify outdated or missing guidance. Done means each published crate has README content explaining its purpose and usage, and the repository README covers building and using the EDL code generation tooling and the C++ and Rust SDKs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100