Skip to content

Correct stale documentation and remove dead files - #9148

Merged
MaxGhenis merged 1 commit into
mainfrom
docs-accuracy
Jul 24, 2026
Merged

Correct stale documentation and remove dead files#9148
MaxGhenis merged 1 commit into
mainfrom
docs-accuracy

Conversation

@MaxGhenis

Copy link
Copy Markdown
Contributor

Docs-accuracy sweep of README.md, CONTRIBUTING.md, CLAUDE.md, AGENTS.md, and .github templates. Every change is grounded in a verified mismatch between the doc and the repo:

Doc claim Reality (evidence)
"Python 3.11–3.14" (CONTRIBUTING), ">= 3.11" (CLAUDE) requires-python = ">=3.9,<3.15"; classifiers and the CI smoke-import matrix cover 3.9–3.14 (py3.9/3.10 kept for Census per pyproject comment)
make test-yaml-no-structural No such target — the suites are sharded (test-yaml-no-structural-states, -other-irs, …); docs now list real shards
make install # install deps (uv) The target runs pip install -e .[dev]; CI installs with uv sync --extra dev
"create the branch on upstream (make push-pr-branch)" No such target anywhere in the repo; replaced with the actual command
"Fork PRs can't access repository secrets and CI fails on data-download steps" PR CI has no data downloads and its only secret is CODECOV_TOKEN on an upload step with fail_ci_if_error: false (codecov passes tokenless); fork PRs run the full suite green — e.g. #9106#9142 merged from a fork today. The partner-notice workflow already uses pull_request_target.
"bump verified_years" 35 of 39 programs.yaml entries use verified_start_year; docs now name both fields
README codecov badge → branch/master refs/heads/master no longer exists upstream; badge now points at main
README "Code style: black" badge Repo formats with ruff (Makefile, CI lint, dev extras); badge swapped
AGENTS.md: ask the three partner questions "separately, one at a time" CLAUDE.md (which AGENTS.md defers to) prescribes a single AskUserQuestion call; both AGENTS.md files now match

Deleted dead files: .github/PULL_REQUEST_TEMPLATE.md (0 bytes since 2023, renders nothing), .github/changelog_template.md (orphaned by the towncrier migration; zero references; towncrier configures no template), and LANE_STATUS.md + PR_BODY.md (lane working files committed by accident in #8922 — LANE_STATUS still said "PR #8922 open as DRAFT … DO NOT MERGE" about a long-merged PR). Nothing in the repo references any of the four.

Separately discovered and filed as an issue (not touched here because it changes release semantics): 51 changelog fragments sit in forbidden changelog.d/added|fixed/ subdirectories or lack type suffixes, so towncrier and bump_version silently ignore them — those entries never reached any released CHANGELOG.md.

🤖 Generated with Claude Code

Docs-accuracy sweep, every claim verified against the repo:
- CONTRIBUTING/CLAUDE: Python floor is 3.9 (requires-python >=3.9,<3.15;
  CI smoke-imports 3.9-3.14), not 3.11; `make test-yaml-no-structural`
  does not exist (suites are sharded); `make install` runs pip, not uv;
  `make push-pr-branch` does not exist; fork PRs pass CI (the PR
  workflow's only secret is CODECOV_TOKEN with fail_ci_if_error: false
  and no gated-data downloads), so the fork prohibition is stale;
  programs.yaml mostly uses verified_start_year, not verified_years.
- README: codecov badge pointed at the deleted master branch; the
  code-style badge said black but the repo formats with ruff.
- AGENTS.md (root and partners/): the three partner questions are asked
  in a single AskUserQuestion call per CLAUDE.md, not one at a time.
- Removed .github/PULL_REQUEST_TEMPLATE.md (empty since 2023) and
  .github/changelog_template.md (orphaned by the towncrier migration,
  zero references), plus LANE_STATUS.md and PR_BODY.md (lane-session
  working files committed by accident in #8922; LANE_STATUS still said
  "DO NOT MERGE" about a merged PR).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@MaxGhenis
MaxGhenis merged commit 3060147 into main Jul 24, 2026
34 checks passed
@MaxGhenis
MaxGhenis deleted the docs-accuracy branch July 24, 2026 01:33
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