fishinabarrel/linux-kernel-module-rust

Write and publish docs

Open

#150 ouverte le 30 août 2019

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)Rust (122 forks)github user discovery
enhancementgood first issue

Métriques du dépôt

Stars
 (1 340 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Étudiez les options d'hébergement de la documentation (auto hébergé vs docs.rs) et mettez en place un processus de génération et de publication des rustdocs. Assurez vous que la documentation couvre toutes les API publiques.
Stack technique
rust
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
3-5 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
RustGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75