steveklabnik/rustdoc

Guide-style documentation

开放

#24 创建于 2017年7月14日

在 GitHub 查看
 (8 条评论) (0 个反应) (0 位负责人) (22 个派生)github user discovery
E-Mediumenhancementhelp wantedquestion

仓库指标

星标
 (104 个星标)
PR 合并指标
 (30 天内没有已合并 PR)

描述

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.

贡献者指南

研究方向
研究如何将 mdBook 作为库集成，以生成 API 文档之外的指南文档。首先了解 mdBook 的库接口和 rustdoc 的插件系统。
技术栈
rust
领域
documentationdeveloper experience
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Rust
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
50