compio-rs / compio-rs/compio

Improve docs

Open
#553 0 comments 1 reaction 0 assignees View on GitHub
documentation good first issue help wanted
Dominant language
Rust
Stars
1.9k
Forks
133
Avg merge
1d 4h
Merged PRs (30d)
20

Description

I'm proposing a series of changes to improve our document quality. Here're things I'd like to do:

- [x] Fix broken intra doc links (prohibit `rustdoc::broken_intra_doc_links` in future) (#554)
- [x] Fix broken docs.rs builds (See [broken builds](https://docs.rs/crate/compio/0.17.0/builds/2700878)) (#562)
- [x] Separate README.md for each subcrate (#564)
- [x] Forbid broken doc intra link (#574)
- [x] Maintain a rolling doc deployment of master branch
- [ ] Optimization docs as mentioned on [reddit](https://www.reddit.com/r/rust/comments/1ptw1sk/comment/nwxtbtj)
- [ ] Improve grammar and fluency in document

During the process, I think it will be a good chance to revisit some of the old code and make improvements to them as well (like #555). For anyone who's interested in involving, welcome to open a PR!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.