Skip to content

Versions of this site ​

The guide lives in docs/ on the repository's protected main branch. Each page's footer records the installable version it describes and the exact main commit used to build it; version.json records the same facts for tools.

The current release ​

The guide describes the newest public release. Unreleased means the behavior is still absent from the public release. It may already be available in a pre-release. The changelog records those changes too.

Documentation corrections go through ordinary pull requests to main and deploy from there, including during a line of pre-releases. They do not need a separate documentation branch, a new software release, or a moved tag. The footer still names the public version.

Pages checks that manifest.json on the build commit names the newest public release on GitHub. A pre-release leaves that version in place, so the guide can deploy during its preparation and after its publication. A public release updates the manifest in its release pull request. Pages keeps the existing site until the new public version is published and the workflow runs again on main.

Copies of the file format ​

From 0.9.4, the file format is also kept outside this site, so that what a symbol file holds stays known if the site or the repository goes. Every GitHub release carries a copy of it as of the commit the release tags, named by the format's version and the document's revision, listed in the release's SHA256SUMS and attested with its other files. From 1.0.0, each public release is also to ask Software Heritage to archive the repository and the Wayback Machine to keep this site's format page, as the release guide describes.

How it is deployed ​

The Pages workflow builds VitePress from its own main commit, deploys to GitHub Pages, and reads version.json and every page back. It fails unless the pages identify that exact commit. It refuses tags and other branches, and has permission to deploy Pages only: it cannot push code, change tags, or publish a release. The github-pages environment permits deployment from main only.

Describes Inkline 1.0.2, built from 2d435e9 · MIT licensed · Written and maintained by AI agents