Repository navigation
chore(devenv): 0.3.1, docs built with Zensical - #1005
Merged
Merged
Conversation
From the bun update that make update-devenv runs: eslint_d 15.1.0, eslint-plugin-yml 3.10.0 and their lockfile transitive updates. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Raw make update-devenv output against devenv 0.3.1, plus uv lock for the new docs group. - mkdocs.yml, docs/requirements.txt and docs/style.css retired - zensical.toml created from the devenv template - .readthedocs.yaml builds through build.jobs with uv - docs group: mkdocs + mkdocs-minify-plugin -> zensical~=0.1 - source-include: mkdocs and docs/style*.css entries out, zensical.toml in - cfg/docs.mk runs zensical build --strict / zensical serve --open - cfg/eslint.config.base.js ignores site/ Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
zensical.toml [project] takes site_name, site_author, site_description
and nav from the old mkdocs.yml, plus site_url for Read the Docs and the
codex/img/logo.svg theme logo. The style.{material,mkdocs,readthedocs}.css
variants only existed for docs/style.css, which devenv retired.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
update-devenv appended docs/** and zensical.toml after the sorted list. The explicit docs/ files are all inside docs/**; the sdist file list is unchanged (2219 files, compared before and after). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
From the bun update that make update-devenv runs: mdast-util-* and vue-eslint-parser patch releases. package.json is unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Raw make update-devenv output against devenv 0.3.2: the docs palette primary moves from deep purple to indigo (accent orange stays), and zensical.toml enables admonition, pymdownx.details, pymdownx.superfences and pymdownx.quotes callouts. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Raw make update-devenv output against devenv 0.3.3: Markdown lint accepts GitHub callouts (no-missing-label-refs allowLabels for !NOTE, !TIP, !IMPORTANT, !WARNING and !CAUTION). The bun update and uv lock changed nothing. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The Docker Hub move note, the three config deprecation notes and the read-only /comics mount note become > [!WARNING] callouts, which GitHub renders natively and Zensical renders as admonitions through pymdownx.quotes callouts. The bare > line after each marker keeps Prettier's proseWrap from joining the marker onto the text. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The CSRF 403 section now ends with a callout: in general a correctly configured reverse proxy shouldn't need csrf_trusted_origins or CODEX_CSRF_TRUSTED_ORIGINS. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The note that a correctly configured reverse proxy needs no CSRF trusted origins moves from the end of the section to the top, and the first paragraph drops the clause that said the same thing. 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.
devenv 0.3.1 (ajslater/devenv#48, ajslater/devenv#49): the admin guide on Read the Docs builds with Zensical instead of MkDocs. Same pages, same URLs, same heading anchors.
What
make update-devenvchangedmkdocs.yml,docs/requirements.txtanddocs/style.css(a symlink tostyle.mkdocs.css) deletedzensical.tomlcreated from devenv's template: modern variant, darkslatepalette, smarty, toc permalinks, native minify.readthedocs.yamlbuilds throughbuild.jobs:pip install uv, thenuv run --only-group docs --no-dev zensical build --strict, then copiessite/into$READTHEDOCS_OUTPUT/html/. Themkdocs:andpython:keys are gone.mkdocsandmkdocs-minify-pluginreplaced byzensical~=0.1;uv.lockrelocked (zensical 0.1.0, nothing else moved)source-include: the mkdocs anddocs/style*.cssentries out,zensical.tomlincfg/docs.mkrunszensical build --strict/zensical serve --opencfg/eslint.config.base.jsignoressite/. codespell'sskipalready hadsiteand.gitignorealready hadsite/, so neither changed..devenv-version0.2.11 → 0.3.1bun update:eslint_d15.1.0,eslint-plugin-yml3.10.0 (separate commit)Hand edits
zensical.toml[project]:site_name,site_author,site_descriptionandnav = ["NEWS.md", "DOCKER.md"]from the oldmkdocs.yml, plussite_url = "https://codex-comic-reader.readthedocs.io/";[project.theme] logo = "codex/img/logo.svg"docs/style.material.css,docs/style.mkdocs.cssanddocs/style.readthedocs.css, which only existed as targets for the retireddocs/style.csssource-includesorted, with the explicitdocs/…entries thatdocs/**already covers dropped. The sdist file list is identical before and after (2219 files).docs/docs,docs/NEWS/codex,docs/img,docs/codex/img/logo.svg, and theirsource-excludeentriesVerified locally
make docspasses--strict(it never worked under mkdocs, which refused--site-dir docs/site)/from the README,/DOCKER/,/NEWS/and/WINDOWS/, all with theslatescheme, thecodex/img/logo.svglogo and canonical URLs oncodex-comic-reader.readthedocs.io/DOCKER/#migrating-from-docker-hub,/#reset-the-admin-password,/#administration. A crawl of every internalhref/srcand#fragmentinsite/found no broken links, so the README and NEWS relative links through the symlinked directories still resolve.zensical servesite/and.cache/stay out ofgit status; a secondmake update-devenvchanges nothingmake fix lint ty testgreen, withsite/present, so 0.3.1's codespell and ESLint skips work: pytest 1753 passed (1 xfailed), vitest 1070 passedRead the Docs
Not exercised yet. The
codex-comic-readerRTD project buildslatestfrommain, so the live site changes only after this is released tomain. Then checkhttps://codex-comic-reader.readthedocs.io/DOCKER/#migrating-from-docker-hub,/#reset-the-admin-passwordand/#administration. Thebuild.jobsshape is the one already live for treestamps.Also in this branch
a1dff0090 update depswas on localdevelopbut not onorigin/developwhen this branch was cut, so it rides along.Follow-up: devenv 0.3.2 and 0.3.3, warning callouts
fix docs orange:[project.theme.font](Inter, JetBrains Mono) plus a deep purple / orange paletteprimarymoves toindigo(accentorangestays), andzensical.tomlturns onadmonition,pymdownx.details,pymdownx.superfencesandpymdownx.quotes.callouts. Itsbun updatemoved a few transitive lint packages inbun.lock(separate commit).no-missing-label-refsallowLabels)docs:the Docker Hub move note, the three config deprecation notes and the read-only/comicsnote are> [!WARNING]callouts, written with a bare>line after the marker somake fixkeeps them intact. GitHub renders them as alerts, and the Zensical site renders fiveadmonition warningboxes (four on/, one on/DOCKER/). The heading anchors the app links to are unchanged.make docsstrict andmake fix lint ty testgreen again (pytest 1753 passed, 1 xfailed; vitest 1070 passed)🤖 Generated with Claude Code