Skip to content

chore(readme): 読み進めガイドを章ファイル変化に動的対応させる#38

Closed
watanabe-kohei-jp wants to merge 1 commit into
mainfrom
chore/issue-37-dynamic-reading-routes
Closed

chore(readme): 読み進めガイドを章ファイル変化に動的対応させる#38
watanabe-kohei-jp wants to merge 1 commit into
mainfrom
chore/issue-37-dynamic-reading-routes

Conversation

@watanabe-kohei-jp
Copy link
Copy Markdown
Collaborator

Closes #37

目的

README の「## 何が読めるか」と「## 読み進め方(推奨ルート)」の章ファイル名ハードコードを解消し、data/reading-routes.json を正本にして build.py で再生成する構造に変える。章再編・追加・削除のたびに 2 箇所手で直す状況を解消する。

このコミット時点で含まれるもの

  • data/reading-routes.json — 章メタ + ルート定義の正本(このコミット)

後続コミットで入れる予定

  • build.py 拡張: JSON ロード・AUTOGEN 区間置換・整合性チェック・--check モード
  • README.md に AUTOGEN マーカーを 2 箇所挿入(chapters-table / reading-routes
  • .github/workflows/pages-deploy.yml の build ジョブに python build.py --check ステップを追加

ユーザー選択(Issue で確認済み)

  • JSON は chapters[] + routes[] 両方を持つ集約型(「## 何が読めるか」テーブルも自動化)
  • 「### 読み方のスタイル(3 パターン)」と「### どのルートでも共通の前提」は章非依存なので静的のまま

レビューで見てほしい点(最終コミット後に再度依頼予定)

  • JSON スキーマ設計(chapters[] / routes[*].chapters[*] / extras[] / {slides} プレースホルダ)の妥当性
  • AUTOGEN マーカー形式(HTML コメント、GitHub レンダリングで非表示)
  • --check の CI 統合方法(pages-deploy.yml への統合)

関連


🤖 Generated with Claude Code

README の「## 何が読めるか」と「## 読み進め方(推奨ルート)」の
正本ファイル。後続コミットで build.py がここから README の AUTOGEN
区間を再生成する。

スキーマ:
- chapters[] — 章メタ(dir / title / slides)。章 ID = dir 名
- routes_intro — ルートセクション冒頭文
- routes[] — 推奨ルート(id / label / duration_min / audience / goal /
  chapters[] / extras[])
  - chapters[*].note に {slides} プレースホルダで章のスライド数を埋め込み可
  - extras[] で章ディレクトリ以外(CONTRIBUTING.md など)も混ぜられる

Refs #37
@watanabe-kohei-jp
Copy link
Copy Markdown
Collaborator Author

PR #36 と重複のためクローズ

PR #36 (feat(automation): auto-sync listings from NN-slug/index.html) が main にマージされ、本 PR のスコープ大部分(README の ## 何が読めるか 章テーブル自動化)が既に実装されました。さらに PR #36scripts/sync_listings.py で各章 index.html<meta> を真実源とする 方針を採っており、本 PR の data/reading-routes.json 中心の設計と方針が衝突します(真実源が 2 つになる)。

残された価値あるスコープ

本 PR の成果物の扱い

  • data/reading-routes.json — 後続 Issue で scripts/sync_listings.py 拡張時のスキーマ参考にする
  • build.py 拡張(未コミット) — 破棄。scripts/sync_listings.py 側に書き直す

Closes by superseded work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore(readme): 読み進め方ガイドを章変化に動的対応させる(ルート定義 YAML + build.py 自動生成)

1 participant