compio-rs/compio

Improve docs

Aberta

#553 aberto em 2 de dez. de 2025

Ver no GitHubGuia do colaborador
 (0 comentário) (1 reação) (0 responsável)Rust (120 forks)github user discovery
documentationgood first issuehelp wanted

Métricas do repositório

Stars
 (1.732 estrelas)
Métricas de merge de PR
 (Mesclagem média 2d 3h) (14 fundiu PRs em 30d)

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!

Guia do colaborador

Direção de pesquisa
Concentre se nas tarefas restantes: escreva a documentação de otimização com base no tópico do Reddit e melhore a gramática e a fluência nos documentos existentes. Comece lendo a estrutura de documentação do projeto e a postagem do Reddit mencionada.
Pilha de tecnologia
rust
Domain
documentationbackend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
RustGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60