steveklabnik/rustdoc

Guide-style documentation

Aberta

#24 aberto em 14 de jul. de 2017

Ver no GitHub
 (8 comentários) (0 reação) (0 responsável) (22 forks)github user discovery
E-Mediumenhancementhelp wantedquestion

Métricas do repositório

Stars
 (104 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Rustdoc should not just provide API documentation, but also support long-form, guide documentation.

My current thought is "use https://github.com/azerupi/mdBook as a library" to do this, but I am open to other thoughts as well.

Guia do colaborador

Direção de pesquisa
Investigue como integrar o mdBook como biblioteca para produzir documentação de guia junto com a documentação da API. Comece entendendo a API de biblioteca do mdBook e o sistema de plugins do rustdoc.
Pilha de tecnologia
rust
Domain
documentationdeveloper experience
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
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
Rust
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50