steveklabnik/rustdoc

Guide-style documentation

Ouverte

#24 ouverte le 14 juil. 2017

Voir sur GitHub
 (8 commentaires) (0 réaction) (0 personne assignée) (22 forks)github user discovery
E-Mediumenhancementhelp wantedquestion

Métriques du dépôt

Stars
 (104 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Étudiez comment intégrer mdBook en tant que bibliothèque pour produire une documentation guide en complément de la documentation API. Commencez par comprendre l'API bibliothèque de mdBook et le système de plugins de rustdoc.
Stack technique
rust
Domaine
documentationdeveloper experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Rust
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
50