docs: slim package READMEs by /doc policy#117
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 優先)manipulateDOMのbaseURL/getHref(linkedom の制約への対応)formatOptions.parseErrorポリシー(silent / warning / error)残作業(別 PR で対応予定)
README.ja.md/ARCHITECTURE.ja.md) を英語版に合わせて同期Test plan
lint-staged(prettier / textlint / cspell)が通過yarn lint/yarn build/yarn test)の確認🤖 Generated with Claude Code