firebase / firebase/firebase-admin-java
FR: Source maps for docs
オープン
type: feature request
- 主要言語
- Java
- スター
- 620
- フォーク
- 305
- 平均マージ
- 3時間 23分
- マージ済み PR(30日)
- 1
説明
Add a source map to the doc generation process so that reference docs can link directly into source files for each function/constant/etc.
コントリビューションガイド
調査の方向性
まずリポジトリ内のドキュメント生成プロセスを見つけ、関数と定数のリファレンスドキュメントがどのように生成されるかを調査します。source map がどこに出力されるか、また生成されたリンクがソースファイル内の対応する位置をどのように指すべきかを特定します。リファレンスドキュメントが対応するソースコードの位置に直接リンクするようになれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java
- 領域
- build-system, documentation
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100