Create static website for API documentation
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 355
- Forks
- 24
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 17
Description
Right now, our entire API documentation is placed in the README. We should provide a static documentation website with details about the API.
Question: we want to eventually publish Rubydex as a crate too. Does Rust automatically generate the documentation websites for crates? Or do we need to account for both the Rust and Ruby API as part of this static website?
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 with the API documentation currently in the README and determine how Rust crate documentation would be generated and published. Resolve whether the site should cover the Rust API, Ruby API, or both, then define the static site's scope and publication approach. Done means the agreed API documentation is available on a static website.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby, rust
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100