The documentation of WebAuthn Framework

The public documentation of WebAuthn Framework, WebAuthn and passkeys for PHP and Symfony: the ceremonies, the pure PHP library, the Symfony bundle and the Symfony UX components.

Published with MkDocs and Material for MkDocs on GitHub Pages: https://webauthn-doc.spomky-labs.com/

Writing

make install   # the toolchain, in .venv, from requirements.txt
make serve     # http://127.0.0.1:8000, rebuilt as you save
make check     # the strict build continuous integration runs

make check is the gate: a broken internal link, an anchor that does not exist, a page absent from the navigation or a navigation entry without a page fails the build.

Where things are

Path	What it is
mkdocs.yml	The site: theme, extensions, plugins, and the whole navigation
docs/	The pages, one directory per section of the navigation
docs/assets/stylesheets/	The look: slabs-tokens.css, copied as it is from the Slabs design kit, and slabs.css, which applies the guidelines to the theme
docs/assets/brand/, docs/assets/fonts/	The project mark, the signature, the favicons and the share image of the design kit, and its typefaces (SIL Open Font License)
docs/overrides/	Theme partials: the logo, the footer, the link to the repository
site-root/	The root of the published site, copied to the root of the gh-pages branch: CNAME, and the 404.html that sends the addresses of the former GitBook site to their version
requirements.txt	The toolchain, pinned. Continuous integration installs exactly this
.github/workflows/check.yml	The strict build, on every pull request
.github/workflows/pages.yml	The publication: one version per branch, through mike
.github/workflows/default-branch.yml	A new version branch becomes the default branch

How the documentation left GitBook, and the rules every documentation site of Slabs follows, are in Spomky-Labs/docs.

One branch per version

A branch of this repository is a version of the packages: 5.2, 5.3, 5.4, the three minor versions the library maintains. A push to one of them publishes it under its own name, and the newest one also carries the latest alias, which the root of the site redirects to. A fix that applies to several versions is made on each of them.

git switch -c 5.5 5.4         # from the version it continues
# in mkdocs.yml, point edit_uri at the new branch
git push -u origin 5.5        # publishes it, and moves "latest" and the default branch