fishinabarrel/linux-kernel-module-rust

Write and publish docs

Open

#150 aberto em 30 de ago. de 2019

Ver no GitHub
 (4 comments) (0 reactions) (0 assignees)Rust (122 forks)github user discovery
enhancementgood first issue

Métricas do repositório

Stars
 (1.340 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

We should have docs for at least all public APIs, and published rustdocs linked from the README.

It's not super straightforward to use this repo with crates.io (you need a local checkout for getting to the target JSON file, see #1). docs.rs automatically publishes crates on crates.io; I'm not sure if we want to publish the crate for the sake of using that (+ getting into things like crater runs?), or just self-host docs. (I run enough websites that I'm not going to be sad about self-hosting docs somewhere....)

Guia do colaborador

Direção de pesquisa
Investigue opções de hospedagem de documentação (auto hospedado vs docs.rs) e configure um processo para gerar e publicar rustdocs. Garanta que a documentação cubra todas as APIs públicas.
Pilha de tecnologia
rust
Domain
documentation
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.
3-5 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
RustGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75