Skip to content

docs: update documentation for v0.6.4 - #63

Merged
linghengqian merged 1 commit into
mainfrom
docs/v0.6.4-refresh
Nov 14, 2026
Merged

linghengqian merged 1 commit into
mainfrom
docs/v0.6.4-refresh

Conversation

@linghengqian

Copy link
Copy Markdown
Member

Summary

Brings the English and Chinese documentation in line with v0.6.4 (#59, #61 and #62 are already on main). Several statements were stale or unclear after those PRs. This PR changes only documentation; there are no code changes.

Changes

  • Changelog: the Unreleased section is now 0.6.4 in both languages, with a CI entry for the docs check, the Linux container install and the index retry check.
  • Install from source: the zip command no longer includes bin, which v0.6.4 removed with the WiX tools.
  • Development: the container suite description covers the default uv-build install check on Linux, not only GraalPy. The environment table lists PreInstall as a reader of GITHUB_TOKEN and GH_TOKEN.
  • uv: the libc fallback is stated per mode. VFOX_PYTHON_USE_UV_BUILD=1 warns and uses gnu; the default mode builds from source.
  • E2E: the Linux Dockerfile row names vfox 1.1.0.
  • Platforms (Chinese): the bare Ubuntu container sentence says it installs CPython with the default settings.
  • READMEs: the pyenv credit no longer says the default installs use pyenv.

Checks

  • python3 -I .github/scripts/check_docs_parity.py .: 12 page pairs agree.
  • git diff --check: clean.
  • Each changed statement was checked against this head: hooks/pre_install.lua, lib/util.lua (libc detection, GraalPy GitHub requests), tests/e2e/linux/container_test.go, tests/e2e/linux/Dockerfile, and .github/workflows/test.yml.

Not checked here

  • docs/link.md, docs/graalpy.md, docs/windows-launcher.md and docs/mirror.md (with their Chinese pages) were checked by keyword search only, not read line by line.
  • The Chinese wording in the changed paragraphs needs a native reader. CI checks the structure of the pages, not the translation.
  • No Lua code changed, so vfox plugin test was not run.

- Name the Unreleased changelog section 0.6.4 in both languages, and add a
  CI entry for the docs check, the Linux container install and the index
  retry check.
- Drop bin from the install-from-source zip command; v0.6.4 removed bin/.
- Describe the Linux container suite as checking the default uv-build
  install, not only GraalPy, and list PreInstall as a reader of
  GITHUB_TOKEN.
- State the libc fallback per mode: VFOX_PYTHON_USE_UV_BUILD=1 warns and
  uses gnu, while the default mode builds from source.
- Name vfox 1.1.0 in the Linux E2E Dockerfile row, say the bare Ubuntu
  container installs CPython with the default settings, and reword the
  pyenv credit in the READMEs.
@linghengqian linghengqian added the documentation Improvements or additions to documentation label Nov 14, 2026
@linghengqian
linghengqian merged commit 4bedd8d into main Nov 14, 2026
11 checks passed
@linghengqian
linghengqian deleted the docs/v0.6.4-refresh branch November 14, 2026 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant