feat: 初学者向けGitHub用語集を追加#229
Conversation
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1765914bef
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
Pull request overview
初学者向けに独立した Git/GitHub 用語集(付録D)を追加し、公開導線(トップ/ナビゲーション/appendicesの前後関係)と book-config.json のUXフラグを整合させたうえで、CIで「用語集の実体・導線・定義/章リンク・ミラー一致」を契約チェックとして必須化するPRです。
Changes:
- 用語集ページ(manuscript / docs)を新規追加し、トップページと常設ナビゲーションから到達できるように更新
book-config.jsonに glossary appendix とux.modules.glossary=trueを追加- 用語集の契約検証スクリプトを追加し、
npm testと Book QA ワークフローで必須実行
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/check-glossary-contract.js | 用語集の存在・設定・導線・見出し/定義/関連章リンク・ミラー一致を検証する契約チェックを追加 |
| package.json | check:glossary を追加し、npm test に glossary 契約チェックを組み込み |
| manuscript/appendices/appendix-glossary/index.md | 用語集(付録D)の原稿を新規追加 |
| docs/appendices/appendix-glossary/index.md | GitHub Pages公開用の用語集ページを新規追加 |
| docs/index.md | トップページに付録Dへのリンクを追加 |
| docs/_data/navigation.yml | 常設ナビゲーション(appendices)に付録Dを追加 |
| book-config.json | appendix定義に glossary を追加し、ux.modules.glossary を true に更新 |
| .github/workflows/book-qa.yml | Book QA で glossary 契約チェックを必須実行 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@codex review Review exact head |
|
Codex Review: Didn't find any major issues. What shall we delve into next? Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
概要
PortalのProfile A必須module監査で確認された用語集不足を解消します。
book-config.jsonの公開実体とux.modules.glossaryを整合公開route
/appendices/appendix-glossary/正本と同期
manuscript/appendices/appendix-glossary/index.mddocs/appendices/appendix-glossary/index.mdsrc/**は変更していません検証
npm ci(audit 0)npm testnpm run docs:quality-gatepython3 scripts/check_markdown_internal_links.py docs/appendices/appendix-glossary/index.mdnpx markdownlint docs/appendices/appendix-glossary/index.md manuscript/appendices/appendix-glossary/index.mdnpm run buildgit diff --check非スコープ
Ruby default gem / minima / Sass deprecation warningは既存Issue #225で追跡しており、本PRへ混在させていません。
Closes #228
Parent: itdojp/it-engineer-knowledge-architecture#227