Skip to content

Check reviewer markdown link integrity#49

Merged
stacknil merged 2 commits into
mainfrom
stacknil/reviewer-link-integrity
May 31, 2026
Merged

Check reviewer markdown link integrity#49
stacknil merged 2 commits into
mainfrom
stacknil/reviewer-link-integrity

Conversation

@stacknil
Copy link
Copy Markdown
Owner

Summary

  • Adds a local Markdown link integrity regression test for README, docs, and demo README files
  • Checks repository-relative links and image paths without requiring network access
  • Protects reviewer navigation surfaces from broken local links during consolidation

Validation

  • pytest tests/test_markdown_links.py --basetemp .pytest-artifacts-markdown-links
  • pytest --basetemp .pytest-artifacts-full-20260531-1
  • git diff --cached --check

Copy link
Copy Markdown

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

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: 97aefb6992

ℹ️ 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 tests/test_markdown_links.py Outdated
def _markdown_files() -> list[Path]:
return [
REPO_ROOT / "README.md",
*sorted((REPO_ROOT / "docs").glob("*.md")),
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 Include nested docs in link check

The repo already contains Markdown files below nested docs/ directories, such as docs/reviewer-pack-v0.4.0/MANIFEST.md and docs/reviewer-pack-v0.6.0/MANIFEST.md, but this helper only collects top-level docs/*.md. Any local link added to those reviewer-pack manifests can break without this regression test failing, which leaves part of the documented reviewer surface outside the new integrity check; use a recursive docs scan if the test is meant to cover docs broadly.

Useful? React with 👍 / 👎.

@stacknil
Copy link
Copy Markdown
Owner Author

Addressed the Codex review feedback in 7479bb8 by changing the Markdown link collector to scan nested docs and demo Markdown recursively. Local validation: pytest tests/test_markdown_links.py --basetemp .pytest-artifacts-markdown-links-v2 and pytest --basetemp .pytest-artifacts-full-20260531-2.

@stacknil stacknil merged commit c54da78 into main May 31, 2026
2 checks passed
@stacknil stacknil deleted the stacknil/reviewer-link-integrity branch May 31, 2026 08:41
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