compio-rs/compio

Improve docs

開放

#553 建立於 2025年12月2日

 (0 則留言) (1 個反應) (0 位負責人)Rust (120 個分叉)github user discovery
documentationgood first issuehelp wanted

倉庫指標

星標
 (1,732 顆星)
PR 合併指標
 (平均合併 2天 3小時) (30 天內合併 14 個 PR)

描述

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_links in 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!

貢獻者指南