[mkdocs] - explore how to move away from multiple .html files to just one .md file per page
オープン
まだ誰も着手していません。
- 主要言語
- JavaScript
- スター
- 18.3k
- フォーク
- 2k
- 平均マージ
- 2日 12時間
- マージ済み PR（30日）
- 28
説明
We should move away from having .html files as the files that you edit to make changes to the docs. Ideally to edit the docs you'd edit a .md file and everything for a specific page is in the one .md file.
Having multiple html files for one page like we have in our existing docs, makes it challenging to create new content and edit existing content.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、既存のドキュメントが各ページごとに複数の .html ファイルにどのように分割され、それらのファイルがどのようにビルドされるかを確認します。既存のドキュメントの内容と出力を維持しながら、各ページを 1 つの .md ファイルで編集できるようにする移行方針を定義します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- markdown
- 領域
- documentation
- issue の種類
- リファクタリング
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 30/100