Skip to content

[codex] Add external reference audit playbook#49

Merged
ootakazuhiko merged 1 commit into
mainfrom
codex/github-agentops-quality-sprint-20260525
May 24, 2026
Merged

[codex] Add external reference audit playbook#49
ootakazuhiko merged 1 commit into
mainfrom
codex/github-agentops-quality-sprint-20260525

Conversation

@ootakazuhiko

Copy link
Copy Markdown
Collaborator

Summary

  • Add an external-link audit / official-information freshness playbook to Appendix B.
  • Extend Appendix C troubleshooting guidance for links that are reachable but semantically stale.
  • Regenerate docs/ from src/ so GitHub Pages content stays aligned.

Refs itdojp/it-engineer-knowledge-architecture#152

Validation

  • git diff --check
  • npm test
  • npm run check-external-links (65 unique external links)
  • node /home/devuser/work/CodeX/booksB/.codex-local/tmp/book-formatter/scripts/check-unicode.js docs --allowlist .book-formatter/unicode-allowlist.json --fail-on warn
  • node /home/devuser/work/CodeX/booksB/.codex-local/tmp/book-formatter/scripts/check-textlint.js docs --fail-on error
  • node /home/devuser/work/CodeX/booksB/.codex-local/tmp/book-formatter/scripts/check-links.js docs
  • node /home/devuser/work/CodeX/booksB/.codex-local/tmp/book-formatter/scripts/check-layout-risk.js docs --fail-on error --output /home/devuser/work/CodeX/booksB/.codex-local/tmp/github-agentops-layout-risk.json
  • node /home/devuser/work/CodeX/booksB/.codex-local/tmp/book-formatter/scripts/check-markdown-structure.js docs --fail-on error --output /home/devuser/work/CodeX/booksB/.codex-local/tmp/github-agentops-markdown-structure.json
  • BUNDLE_PATH=/home/devuser/work/CodeX/booksB/.codex-local/tmp/bundle-github-agentops bundle exec jekyll build --source docs --destination /home/devuser/work/CodeX/booksB/.codex-local/tmp/github-agentops-site --baseurl /GitHub-AgentOps-book
  • Built-site marker smoke for Appendix B, Appendix C, and top page

Notes

  • Scope is intentionally documentation-only and limited to quality-sprint P2/P3 maintenance guidance.
  • The repo had no open issues or PRs before this slice; the portfolio tracking issue is used as the linked issue.

Copilot AI review requested due to automatic review settings May 24, 2026 22:17

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

Appendix B/C の運用・トラブルシューティングに「外部リンクの到達性」だけでなく「公式情報の鮮度(plan/preview/quota/課金/権限/API 名など)」も監査対象に含めるためのプレイブックを追加し、公開用 docs/ を再生成して GitHub Pages と整合させる PR です。

Changes:

  • 付録Bに「外部リンク棚卸し / 公式情報鮮度確認」の推奨手順・停止条件・evidence を追加
  • 付録Cの「ドキュメントのリンク切れ / ビルド失敗」に、到達するが情報が古いケースと最小対処を追加
  • src/ の更新内容に合わせて docs/ を再生成

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
src/appendices/appendix-b/index.md 外部リンク棚卸しと公式情報鮮度確認のプレイブックを追加
src/appendices/appendix-c/index.md 外部リンクの「到達性」以外(情報の陳腐化)も含む対処・再発防止を追記
docs/appendices/appendix-b/index.md 上記 Appendix B 変更の生成物反映
docs/appendices/appendix-c/index.md 上記 Appendix C 変更の生成物反映

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Collaborator Author

Copilot review の本文とインラインコメントを確認しました。

  • Copilot は 4/4 files を review 済みです。
  • generated comments は 0 件で、inline comment / suggestion はありませんでした。
  • review thread は 0 件、unresolved thread も 0 件です。
  • pr-review-completenessstatus=ok(reviews=1, review_comments=0, review_threads=0, unresolved_threads=0)でした。
  • PR head の qa / test / docs-forbidden はすべて成功しています。

そのため追加修正は不要と判断します。

@ootakazuhiko
ootakazuhiko merged commit 57bb2b1 into main May 24, 2026
4 checks passed
@ootakazuhiko
ootakazuhiko deleted the codex/github-agentops-quality-sprint-20260525 branch May 24, 2026 22:20
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.

2 participants