jwir3 / jwir3/cratchit

Add documentation for cratchit

Open
#13 0 comments 0 reactions 0 assignees View on GitHub
task
Dominant language
Rust
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

We should add code-level documentation to cratchit so when we publish to crates.io, the documentation gets published as well.

Additionally, we should add a badge to indicate the state of the docs.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the Rust crate's public code and its crates.io publication setup. Add the requested code-level documentation and a badge showing the documentation state; done means the documentation is published with the crate and the badge is present.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.