parallaxsecond / parallaxsecond/rust-tss-esapi
Add examples in documentation
Open
Nobody has claimed this yet.
documentation
enhancement
good first issue
help wanted
- Dominant language
- Rust
- Stars
- 135
- Forks
- 80
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 5
Description
At the moment our documentation is purely comment-based and should be enhanced with some working examples of how to use the functionality within.
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
Review the crate's existing comment-based documentation and identify the functionality that lacks practical usage guidance. Define a small set of working examples that cover the intended usage, then verify that each example is understandable and builds successfully with the project.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100