steveklabnik/rustdoc

Guide-style documentation

Offen

#24 geöffnet am 14.07.2017

Auf GitHub ansehen
 (8 Kommentare) (0 Reaktionen) (0 zugewiesene Personen) (22 Forks)github user discovery
E-Mediumenhancementhelp wantedquestion

Repository-Metriken

Stars
 (104 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuche, wie mdBook als Bibliothek integriert werden kann, um neben der API Dokumentation auch Leitfadendokumentation zu erstellen. Beginne mit dem Verständnis der Bibliotheks API von mdBook und des Plugin Systems von rustdoc.
Tech Stack
rust
Domain
documentationdeveloper experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Rust
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50