Skip to content

feat: 初学者向けGitHub用語集を追加#229

Merged
ootakazuhiko merged 2 commits into
mainfrom
codex/issue-228-glossary
Jul 13, 2026
Merged

feat: 初学者向けGitHub用語集を追加#229
ootakazuhiko merged 2 commits into
mainfrom
codex/issue-228-glossary

Conversation

@ootakazuhiko

Copy link
Copy Markdown
Collaborator

概要

PortalのProfile A必須module監査で確認された用語集不足を解消します。

  • 初学者向けの独立したGit/GitHub用語集を追加
  • 各用語に短い定義と関連章リンクを付与
  • canonical route、トップ、常設navigation、付録の前後導線を追加
  • book-config.jsonの公開実体とux.modules.glossaryを整合
  • 用語集の実体・mirror・route・navigation・各用語の定義/章リンク・flagをfail-closedで検証
  • Book QAで用語集契約を必須実行

公開route

  • /appendices/appendix-glossary/

正本と同期

  • 正本: manuscript/appendices/appendix-glossary/index.md
  • 公開mirror: docs/appendices/appendix-glossary/index.md
  • legacy src/**は変更していません

検証

  • npm ci(audit 0)
  • npm test
  • npm run docs:quality-gate
  • python3 scripts/check_markdown_internal_links.py docs/appendices/appendix-glossary/index.md
  • npx markdownlint docs/appendices/appendix-glossary/index.md manuscript/appendices/appendix-glossary/index.md
  • npm run build
  • built route、トップ導線、付録Cからの前ページ導線、次ページなしをHTMLで確認
  • git diff --check
  • 独立レビュー初回2件を修正し、再レビューでmajor/moderate finding 0

非スコープ

Ruby default gem / minima / Sass deprecation warningは既存Issue #225で追跡しており、本PRへ混在させていません。

Closes #228

Parent: itdojp/it-engineer-knowledge-architecture#227

Copilot AI review requested due to automatic review settings July 13, 2026 10:15
@ootakazuhiko

Copy link
Copy Markdown
Collaborator Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread scripts/check-glossary-contract.js Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread scripts/check-glossary-contract.js
Comment thread scripts/check-glossary-contract.js
@ootakazuhiko

Copy link
Copy Markdown
Collaborator Author

@codex review

Review exact head 248e8e87a24ffa900d8cbcf0c06c2a6f53ebbf23. The three prior threads were addressed by moving the canonical manuscript appendix to the repository's flat layout, documenting it in AGENTS.md, and normalizing EOLs in the contract checker. Please review the full PR at this head.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. What shall we delve into next?

Reviewed commit: 248e8e87a2

ℹ️ 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".

@ootakazuhiko ootakazuhiko merged commit 4ec9dd0 into main Jul 13, 2026
3 checks passed
@ootakazuhiko ootakazuhiko deleted the codex/issue-228-glossary branch July 13, 2026 10:42
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.

feat: 初学者向けGitHub用語集を追加する

2 participants