fishinabarrel/linux-kernel-module-rust

Write and publish docs

Open

#150 创建于 2019年8月30日

在 GitHub 查看
 (4 评论) (0 反应) (0 负责人)Rust (122 fork)github user discovery
enhancementgood first issue

仓库指标

Star
 (1,340 star)
PR 合并指标
 (30 天内没有已合并 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....)

贡献者指南