Skip to content

docs: slim package READMEs by /doc policy#117

Merged
YusukeHirao merged 2 commits into
devfrom
docs/why-to-jsdoc-migration
Jun 18, 2026
Merged

docs: slim package READMEs by /doc policy#117
YusukeHirao merged 2 commits into
devfrom
docs/why-to-jsdoc-migration

Conversation

@YusukeHirao

Copy link
Copy Markdown
Member

Summary

/doc/product-manager の方針に従い、各パッケージの README.md から WHAT(実装・型定義・--help で自明な情報)を削除し、WHY(実装を見ても分からない設計判断・罠・トレードオフ)を残した。

スリム化したファイル

  • packages/kamado/README.md — 692 → ~150 行
  • packages/@kamado-io/page-compiler/README.md — 967 → ~120 行
  • packages/@kamado-io/pug-compiler/README.md — 194 → ~50 行
  • packages/@kamado-io/script-compiler/README.md — 46 → ~35 行
  • packages/@kamado-io/style-compiler/README.md — 48 → ~40 行

合計 ~1,700 行削減

ARCHITECTURE.md は残した理由

tools リポジトリと異なり、kamado の packages/kamado/ARCHITECTURE.md (648 行) は WHY 密度が極めて高い 文書(mode propagation、incremental build の verifying trace、Config invariance、CompilableFileMap の役割、outputPathField の解決ルール、依存追跡の二層構造など)。/doc 方針の「その他の MD: 実装を見ても分からない WHY または手順は許容」に該当するため、今回は残した。将来 src の JSDoc に分散する場合は別 PR で扱う。

残す WHY の例

  • compileHooks / transforms は build/serve ごとに 1 回解決される(ファイル間で状態を持たない契約)
  • pageList フック時点では metaData は未 populate(__NO_TITLE__ 回避のため明示設定が必要)
  • outputPathField は opt-in(既存 frontmatter キーが routing に誤解釈されない)
  • outputPathConflict の勝者選択ルール(first-seen + override 優先)
  • manipulateDOMbaseURL / getHref(linkedom の制約への対応)
  • formatOptions.parseError ポリシー(silent / warning / error)

残作業(別 PR で対応予定)

  • 日本語版 README/ARCHITECTURE (README.ja.md / ARCHITECTURE.ja.md) を英語版に合わせて同期

Test plan

  • lint-staged(prettier / textlint / cspell)が通過
  • CI(yarn lint / yarn build / yarn test)の確認

🤖 Generated with Claude Code

@YusukeHirao YusukeHirao requested a review from yusasa16 as a code owner June 14, 2026 16:48
@YusukeHirao YusukeHirao merged commit 3dc2ff5 into dev Jun 18, 2026
1 check passed
@YusukeHirao YusukeHirao deleted the docs/why-to-jsdoc-migration branch June 18, 2026 13:03
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.

1 participant