compio-rs/compio

Improve docs

Ouverte

#553 ouverte le 2 déc. 2025

 (0 commentaire) (1 réaction) (0 personne assignée)Rust (120 forks)github user discovery
documentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (1 732 étoiles)
Métriques de merge PR
 (Merge moyen 2j 3h) (14 PRs mergées en 30 j)

Description

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!

Guide contributeur