steveklabnik/rustdoc

Guide-style documentation

Aperta

#24 aperta il 14 lug 2017

Vedi su GitHub
 (8 commenti) (0 reazioni) (0 assegnatari) (22 fork)github user discovery
E-Mediumenhancementhelp wantedquestion

Metriche repository

Star
 (104 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Studia come integrare mdBook come libreria per produrre documentazione guida insieme alla documentazione API. Inizia comprendendo l'API libreria di mdBook e il sistema di plugin di rustdoc.
Tech stack
rust
Dominio
documentationdeveloper experience
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 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
Rust
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50