High Level Docs
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.4k
- Forks
- 98
- PR merge metrics
- No merged PRs in 30d
Description
We already have auto-generated API docs. I propose two more kinds:
* High-level overview: These are intended for Rust devs with at least some experience in 2D graphics who would like to explore piet's feature set through prose instead of through examples and API docs.
* The 2D graphics book: This is intended for Rust devs with little to no experience in 2D graphics who would like to learn from scratch using piet.
Contributor guide
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 existing auto-generated API documentation and defining the scope of the proposed high-level overview and 2D graphics book. Decide how the two audiences differ, then outline the required prose and learning path; the work is done when both documentation plans are concrete enough to implement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100