Repository navigation
v2.6.1 - docs: stop publishing duplicate Docker and Windows pages - #1011
Merged
Merged
Conversation
docs/docs/ held symlinks to DOCKER.md, WINDOWS.md and strange.jpg so the README's repo-relative links (docs/DOCKER.md) resolved when the README is the site index. The site published /docs/DOCKER/ and /docs/WINDOWS/ beside /DOCKER/ and /WINDOWS/, and the index linked to the copies. Excluding the copies or redirecting them fails the strict build: the README's links then point at pages that do not exist. So the two links now use the site URL, as the README's Docker Hub link already does, which also fixes them on PyPI. The page symlinks go, and redirect stubs keep the old /docs/ URLs working. docs/docs/strange.jpg stays: it is the README image's site path, like docs/img. docs/NEWS/codex went too: Zensical rewrites NEWS.md's raw <img> to ../codex/img/logo.svg, so the symlink only published an unused copy. Its sdist source-exclude entry goes with it. Bump to 2.6.1. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
The docs site published
/docs/DOCKER/and/docs/WINDOWS/next to/DOCKER/and/WINDOWS/(both pairs were insitemap.xmlwith the same content). The site's index page linked to the copies.Why
docs/docs/existedIt came in with v1.10.0 (#543/#544). It held symlinks to
../DOCKER.md,../WINDOWS.mdand../strange.jpg. Nothing namesdocs/docs(git grepacross the repo,codex/andfrontend/included). It existed so the README's repo-relative links (docs/DOCKER.md,docs/WINDOWS.md,docs/strange.jpg) still resolve whendocs/README.md(a symlink to the README) is the site index. It's the same trick asdocs/imgfor/img/logo.svg.What changed
Deleted, not excluded:
docs/docs/DOCKER.mdanddocs/docs/WINDOWS.md. I tried both ways of keeping the README links as they are, and both failzensical build --strictwith "page does not exist" on README.md:104 and :178:exclude_docs, orSo the two README links now use the site URL, as the README's own Docker Hub callout (line 17) and
DOCKER.mdalready do. That also fixes them on PyPI, which renders the README and can't follow repo-relative links.Added redirects:
/docs/DOCKER/and/docs/WINDOWS/have been public (and in the sitemap) since v1.10.0. Zensical's built-inredirectsplugin turns them into stubs that forward to/DOCKER/and/WINDOWS/, keeping any#anchor. The stubs aren't in the sitemap or the search index. devenv'smerge_toml.pykeeps a project's ownzensical.tomlkeys, so the table survivesupdate-devenv.Kept:
docs/docs/strange.jpg: it's the README image's path on the site; without it the image breaks there.docs/strange.jpg: the README's image on GitHub, and the target of that symlink.Also deleted:
docs/NEWS/codex(a symlink to../codex/) and its sdistsource-excludeentry inpyproject.toml. It's a MkDocs-era leftover. Zensical rewrites NEWS.md's raw<img src="codex/img/logo.svg">to../codex/img/logo.svg, so the only thing the symlink did was publish an unused/NEWS/codex/img/logo.svg.Left alone:
docs/codexanddocs/img. They publish onlylogo.svg(theme logo and the README's/img/logo.svg), no pages.WINDOWS.md, so it's reachable without a nav entry.Version: 2.6.1 in
pyproject.toml,frontend/package.jsonanduv.lock, the same three files the v2.6.0 bump touched. NEWS has a## v2.6.1section.Verification
make docs(strict): "No issues found".site/sitemap.xmllists/,/DOCKER/,/NEWS/and/WINDOWS/, once each. Before: plus/docs/DOCKER/and/docs/WINDOWS/.search.jsonhas the same four pages.hrefandsrcresolves,#fragments included./DOCKER/#migrating-from-docker-hub,/#reset-the-admin-password,/#administration.make fix: clean apart from formatter noise inDockerfile, which I reverted (this PR doesn't touch it).make -k lint: everything passes exceptdockerfmt --check ./Dockerfile. That fails locally on untouched develop too: both local dockerfmt builds (~/go/binand Homebrew) disagree with CI'sghcr.io/reteps/dockerfmt:latest, which passed this same Dockerfile on develop.uv build --sdistbuildscodex-2.6.1.Follow-up (not fixed here)
NEWS.md's logo,
<img src="codex/img/logo.svg">, is broken on GitHub, becausecodex/img/doesn't exist at the repo root. It works on the site./img/logo.svg, which the README uses, would work in both places.🤖 Generated with Claude Code