compio-rs/compio

Improve docs

Aperta

#553 aperta il 2 dic 2025

Vedi su GitHubGuida contributor
 (0 commenti) (1 reazione) (0 assegnatari)Rust (120 fork)github user discovery
documentationgood first issuehelp wanted

Metriche repository

Star
 (1732 stelle)
Metriche merge PR
 (Merge medio 2g 3h) (14 PR mergiate in 30 g)

Descrizione

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!

Guida contributor

Direzione di ricerca
Concentrati sulle attività rimanenti: scrivi la documentazione di ottimizzazione basata sul thread di Reddit e migliora la grammatica e la scorrevolezza nei documenti esistenti. Inizia leggendo la struttura della documentazione del progetto e il post di Reddit menzionato.
Tech stack
rust
Dominio
documentationbackend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
RustGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60