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