Skip to content

Align public docs and dynamic methodology release checks - #99

Merged
transitrix merged 2 commits into
mainfrom
codex/public-docs-methodology-check
Oct 21, 2026
Merged

transitrix merged 2 commits into
mainfrom
codex/public-docs-methodology-check

Conversation

@transitrix

@transitrix transitrix commented Oct 21, 2026 •

Copy link
Copy Markdown
Owner

What changed

The contribution instructions named a private tracker that the public-surface policy disallows. They now offer public pull requests and the support email; an internal tracking reference in the PDF validator is also removed. The README keeps contributor build and publication verification steps while dropping hosting history, runner details and fixed inventory counts.

The methodology page now defaults to GitHub's latest-release URL, so it remains useful without JavaScript or when the API is unavailable. CI executes the page's release-loading code with controlled responses instead of requiring a committed version tag to match a live API response. Tests cover future releases, unavailable or malformed responses, invalid release metadata and URL encoding. The workflow runs when the page, tests or workflow changes; the new test is declared as repository-only.

How it is verified

GitHub Actions at f9bf44e: all 13 checks pass, including CodeQL and the release-loading tests. The auto-merge job is skipped.

  • 13 Python publication tests and 4 Node release-loading tests pass locally.
  • Exact manifest, 58-file consumer build and Pages archive verification pass.
  • Sitemap generation, canonical links, reachability, icons and OG/Twitter checks pass.
  • Library and explainer PDF validators pass with the CI-pinned pypdf version.
  • Public-surface checks pass, including a scan configured for the private tracker named in the previous README. The icon check uses macOS-compatible temporary-file creation locally; its validation logic is unchanged.

The consumer artifact excludes the README, contributor scripts, workflows and new test. Publication remains a separate manual operation.

@transitrix
transitrix marked this pull request as ready for review October 21, 2026 05:31
@transitrix
transitrix merged commit 2ede62c into main Oct 21, 2026
14 checks passed
@transitrix
transitrix deleted the codex/public-docs-methodology-check branch October 21, 2026 05:31
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.

3 participants