Skip to content

Fix package-page links and checks for 0.1.3 - #6

Merged
Lu-ITC merged 2 commits into
mainfrom
codex/package-page-docs-fix
Nov 1, 2026
Merged

Lu-ITC merged 2 commits into
mainfrom
codex/package-page-docs-fix

Conversation

@Lu-ITC

@Lu-ITC Lu-ITC commented Nov 1, 2026 •

Copy link
Copy Markdown
Member

PyPI resolves relative README documentation links beneath the package URL, producing 404s, while copied installation commands still pin an older version. This patch uses absolute documentation links and current-release installation instructions, preserving historical measurements and business copy.

Adds a development-only, hash-pinned Markdown renderer and a CI check of the actual wheel description: README/metadata agreement, rendering, anchors, repository file targets, HTTPS links and stale installation pins. Runtime behavior and dependencies are unchanged; the runtime version string becomes 0.1.3.

Validation: independent local review of the final head has no remaining findings; eight regression tests pass; all 13 rendered README/metadata links return HTTP 200; 7 documented CLI/library/example checks pass against the current SHA-verified PyPI wheel. The new checker also rejects the previously published broken links and stale pins. Existing PR tests remain required before merging.


Note

Low Risk
Documentation, release tooling, and CI only; no changes to handoff validation logic or runtime dependencies.

Overview
Prepares 0.1.3 with README and release copy that work on PyPI and GitHub: relative doc links become absolute HTTPS GitHub URLs, install examples use pip install --upgrade task-handoff-check instead of a pinned older version, and release wording no longer hard-codes a single PyPI version.

Adds development-only hash-pinned Markdown tooling (requirements/docs.txt) plus scripts/check_package_page.py, which builds on the wheel METADATA, confirms the description matches README.md, renders Markdown like PyPI, validates anchors, enforces HTTPS links and in-repo doc targets, and flags stale package==version pins in code blocks. Eight regression tests live in scripts/test_package_page.py, and a new package-page CI job runs those tests, builds the wheel, and runs the checker.

Runtime handoff validation is unchanged (zero runtime dependencies); only __version__ moves to 0.1.3. CONTRIBUTING and CHANGELOG document the release workflow.

Reviewed by Cursor Bugbot for commit 7b261a5. Bugbot is set up for automated code reviews on this repo. Configure here.

@cursor

cursor Bot commented Nov 1, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: 60165061-5f9a-48af-a74f-fa66ca32e213)

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 1, 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-11-01T02:19:06.143273Z 7b261a5 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.

@Lu-ITC
Lu-ITC merged commit c563d95 into main Nov 1, 2026
6 checks passed
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