fishinabarrel/linux-kernel-module-rust

Write and publish docs

Open

#150 opened on 2019年8月30日

GitHub で見る
 (4 comments) (0 reactions) (0 assignees)Rust (122 forks)github user discovery
enhancementgood first issue

Repository metrics

Stars
 (1,340 stars)
PR merge metrics
 (30d に merged PR はありません)

説明

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

コントリビューターガイド