fishinabarrel/linux-kernel-module-rust

Write and publish docs

Open

#150 aperta il 30 ago 2019

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)Rust (122 fork)github user discovery
enhancementgood first issue

Metriche repository

Star
 (1340 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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....)

Guida contributor

Direzione di ricerca
Indaga le opzioni di hosting per la documentazione (self hosted vs docs.rs) e imposta un processo per generare e pubblicare rustdocs. Assicurati che la documentazione copra tutte le API pubbliche.
Tech stack
rust
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
3-5 giorni
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.
75