steveklabnik/rustdoc

Guide-style documentation

オープン

#24 opened on 2017/07/14

GitHub で見る
 (8 件のコメント) (0 件のリアクション) (0 人の担当者) (22 件のフォーク)github user discovery
E-Mediumenhancementhelp wantedquestion

Repository metrics

Stars
 (104 個のスター)
PR merge metrics
 (30d に merged 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のライブラリAPIとrustdocのプラグインシステムを理解することから始めます。
技術スタック
rust
領域
documentationdeveloper experience
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Rust
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50