docs/web の GitHub Pages で、トップページ、索引、チュートリアル一覧、ケーススタディ一覧、リファレンス入口の情報設計や導線を整理する時に使う。入口重複、分類の曖昧さ、学習順の不明瞭さ、ja/en の非対称を直したい時に使う
docs/web の GitHub Pages 入口設計を整理するための skill。
対象は index.rst、tutorials/index.rst、examples/index.rst、reference/index.rst などの案内ページ。
ja/en の構造差分を同時に解消するja/en の対応ページをペアで編集対象にするcd docs && make html で確認するindex.rst では Hero、対象読者別導線、主要入口の3ブロックを優先するtutorials/index.rst には難易度、前提、得られる成果を加えるexamples/index.rst では各ケースの問題設定、利用 API、期待出力を短く示すreference/index.rst は単なる toctree にせず、用途別入口を持たせるcd docs && make html
確認項目:
ja/en の入口構成が大きくずれていないその場合は web_docs_page_rewrite または web_docs_release_gates を使う。