Skip to content

docs: link one tracked agent orchestration reference and test relative links - #176

Merged
Nagi-Inaba merged 2 commits into
mainfrom
agent/doc-links
Oct 19, 2026
Merged

Nagi-Inaba merged 2 commits into
mainfrom
agent/doc-links

Conversation

@Nagi-Inaba

Copy link
Copy Markdown
Owner

Problem

README.md and README.en.md linked the Claude agent orchestration reference through claude/skills/.../agent-orchestration.md. That directory is generated and git-ignored, so the link was dead on GitHub. The Codex, Claude and shared copies are byte-identical apart from line endings, and the two adjacent bullets pointed at the same content.

Change

  • Replace the two adjacent bullets with one that links the tracked source, shared/skill/references/agent-orchestration.md, in both READMEs.
  • Add tests/markdown-links.test.mjs. It lists tracked files with git ls-files, scans inline Markdown links outside code fences, and fails when a relative link does not resolve to a tracked file or directory. It skips with a reason when git is unavailable. It partly overlaps the existing README link test and covers every tracked Markdown file.
  • Add the new test to release-files.json and a CHANGELOG entry.

Verification

  • node --test tests/markdown-links.test.mjs tests/readme-entrypoint.test.mjs tests/readme-i18n.test.mjs: 12 pass, 0 fail
  • node scripts/verify-all.mjs passed on the combined branch of all four fixes (95 test files, Windows / Node.js 24.19.0); remote CI runs it here
  • Codex / Claude parity is not affected (no canonical skill file changed)

Compatibility

  • Schema/profile/procedure version impact: none
  • Migration required: no
  • CHANGELOG updated

Security and privacy

  • No credentials, private URLs, local paths, or real audit evidence are included
  • Public-report/privacy boundaries are unchanged
  • Release preparation, publication and remote CI results are reported separately

Issue

Part of the 2026-10-19 review fixes. Closes no issue.

🤖 Generated with Claude Code

Nagi-Inaba and others added 2 commits October 19, 2026 13:57
…e links

The Claude agent orchestration link in both READMEs pointed at a generated, git-ignored path, so it was dead on GitHub. The Codex, Claude and shared copies are byte-identical apart from line endings, so one bullet now links the shared source. tests/markdown-links.test.mjs keeps relative Markdown links in tracked files resolvable.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-19T11:15:27.321946Z 832eb78 PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@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: 832eb78d80

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

for (const [index, line] of markdown.split(/\r?\n/u).entries()) {
if (line.startsWith("```")) inFence = !inFence;
if (inFence) continue;
for (const match of line.matchAll(/\[[^\]]+\]\((?<target>[^)]+)\)/gu)) {

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Check reference-style Markdown links

The matcher only recognizes inline links of the form [text](target), so a standard reference-style link such as [guide][docs] with [docs]: missing.md is ignored and the test still passes. A broken relative link can therefore be introduced without triggering the repository-wide safeguard this test claims to provide; parse reference definitions as well or use a Markdown parser.

Useful? React with 👍 / 👎.

@Nagi-Inaba
Nagi-Inaba merged commit a5ffa58 into main Oct 19, 2026
6 checks passed
@github-actions
github-actions Bot deleted the agent/doc-links branch October 19, 2026 11: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.

1 participant