Repository navigation
docs: Refresh README, add AGENTS.md router and docs/ topics - #2625
Merged
Merged
Conversation
Co-Authored-By: Joshua Li <[email protected]>
joshuarli
approved these changes
Oct 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs refresh. Docs only, no behavior changes.
Scope: whole repo, no audience filter.
Files
README.md: now covers end users only. It explains how to use the index (URL, wheels only, only versions inpackages.ini, supported Pythons and platforms), has a numbered how-to for adding a package (whatadd_pkgdoes, when CI deploys), and gives the license. The per-optionpackages.inireference moved out.docs/packages-ini.md(new): thepackages.inioption reference that used to be in README, split into build options and validation options. It also notes thatformat_inidrops#comments and that an unknown option fails the build.docs/build-pipeline.md(new): how CI runs build, validate, and deploy, plus hazards. No doc covered this before.runbook/deleting.mdmoved todocs/deleting-packages.md. Nothing referenced the old path, andrunbook/is now empty.AGENTS.md(new): a thin router with commands, invariants, and a topic-to-doc map.CLAUDE.mdis a symlink to it..claude/skills/upgrade-python/SKILL.md: fixed drift left over from the uv migration (feat: uv #1983). Details below.PYTHON-3.14-UPGRADE.md. It is a dated record, and the skill names its path pattern (PYTHON-MAJOR.MINOR-UPGRADE.mdin the repo root), so it stays in the root.Claims corrected
validate_skip_modulesis nowvalidate_skip_imports. The code readsvalidate_skip_imports(validate.pyInfo.from_dct,build.pyPackage.make), and the README's own example already used that name.python_versionsexample used<3.9.PYTHONSinbuild.pystarts at 3.11, so that example could never match. It now uses a real entry,[brotli==1.0.9] python_versions = <3.12, frompackages.ini.Cache-Control: no store, which is not a valid directive. It now saysno-store, the valuebin/upload-artifactsuses (CACHE_NO).python3.11 -m venv /venvin the Dockerfile. That line no longer exists.docker/Dockerfilenow builds/venvwithuv sync.$PWD/venv/bin.build.ymluses$PWD/.venv/bin.imagejob had nocp pyproject.toml uv.lock docker/step.docker/Dockerfilecopies those files (COPY pyproject.toml uv.lock /tmp/build/), andimage.ymlruns thatcpbeforedocker buildx build, so the job as written would fail to build.PYTHONSis now on line 36 ofbuild.pyand line 20 ofvalidate.py).--upgrade-python, builds fail on first error" was not fully true. On Python 3.14,build.pymain()andvalidate.pymain()print!!! WARNING (py3.14)and continue.Claims I could not verify
docs/deleting-packages.mdthat a stale index link "will be cleaned up on the next execution". That depends on howdumb-pypiregenerates pages./venv. The old Dockerfile pinnedpython3.11. With only the new cpython left on PATH,uv syncmay now pick the new Python for the tooling venv.Code that looks wrong (not changed)
build.pymain()(elif python.version == (3, 14)) andvalidate.pymain()(if python == "python3.14") treat any 3.14 failure as a warning. So 3.14 build and validation failures never fail CI. This looks left over from the 3.14 upgrade. Fix: remove the special cases once 3.14 is fully supported.upgrade_all.pymain()discardssubprocess.run(...).returncodeand always returns 0. A failedadd_pkgrun passes silently. Fix: return the return code.Candidates to enforce
PYTHONSinbuild.pyandvalidate.pymust matchVERSIONSindocker/install-pythons(and the PATH entries indocker/Dockerfileandbuild.yml). A test could assert that these lists agree.#comments inpackages.ini.format_inidrops them silently. It could fail when it finds them instead.Skipped
packages.iniandprebuild/scripts: config, so out of scope.Checks run
pre-commit run --files <changed files>: passed (trailing-whitespace and end-of-file-fixer ran; the other hooks had no matching files).test -e: all links resolve.python -m add_pkg --helpandpython -m build --help: checked the flags the docs mention.uv run coverage run -m pytest testsanduv run coverage report: 86 passed. I ran these to confirm the test command in AGENTS.md.via @joshuarli.
--
View Junior Session [Sentry]