documentationgood first issuehelp wanted
Repository metrics
- Stars
- (1,732 個のスター)
- PR merge metrics
- (平均マージ 2d 3h) (30d で 14 merged PRs)
説明
I'm proposing a series of changes to improve our document quality. Here're things I'd like to do:
- Fix broken intra doc links (prohibit
rustdoc::broken_intra_doc_linksin future) (#554) - Fix broken docs.rs builds (See broken builds) (#562)
- Separate README.md for each subcrate (#564)
- Forbid broken doc intra link (#574)
- Maintain a rolling doc deployment of master branch
- Optimization docs as mentioned on reddit
- 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!