[Spomky]

The documentation leaves GitBook for MkDocs and Material for MkDocs, published on GitHub Pages under webauthn-doc.spomky-labs.com, in the look of the Slabs brand guidelines v2.0, with the project mark of WebAuthn Framework in the header. It follows the record of Spomky-Labs/docs, MIGRATING.md.

One pull request per published version: 5.2, 5.3 and 5.4, the three minor versions the library maintains; 5.4 carries latest. The three branches do not contain each other, so each one is converted on its own. Merge them one by one, each after the publication of the previous one: the workflow keeps one run waiting, and a newer one cancels it.

Commits

1. The pages move to docs/: pure renames.
2. The GitBook syntax becomes the syntax of Material, by tools/gitbook2material.py of Spomky-Labs/docs: admonitions, titled fences, the code blocks GitBook exported as HTML become fences with their highlighted lines, the images move to docs/assets/images/ under names without spaces, and the images no page used are dropped.
3. Every title in sentence case; WebAuthn, Symfony, Symfony UX, Stimulus, Doctrine, JavaScript, the acronyms and the extension names keep their capitals.
4. Links that led nowhere, already broken on GitBook: the serializer (documented on the page of input loading) and, in 5.2, the Symfony way (in symfony-bundle/).
5. The toolchain, the look and the domain, from the documentation of JWT Framework.
6. The passkey logo shows: the figure becomes a figure of Material, whose image path MkDocs rewrites.

Versions and addresses

The GitBook variants v5.2 and v5.4 go to their version. The root (which served 5.3) and every other variant (v5.1 down to v1.x-1) go to the same page of latest, or to its home page when the page is gone. In 5.4, migration/from-v5.x-to-v6.0, the guide the root served, is redirected to migration/from-v5.4-to-v6.0.

Checked

• mkdocs build --strict passes on the three branches.
• The three versions published by mike from scratch and served with the behaviour of GitHub Pages: each of the 586 addresses of the GitBook sitemaps lands on a page, and every address of the root, v5.2 and v5.4 on its own page.
• The rendering in both colour schemes.

Before the DNS moves

The organization web-auth must verify the domain first (Settings of the organization → Pages → Add a domain → webauthn-doc.spomky-labs.com, then the TXT record at Infomaniak): Spomky-Labs has verified spomky-labs.com, and Pages refuses the domain to a repository of another organization until its own organization has verified it. Then: Settings → Pages of this repository, deploy from gh-pages; the CNAME of webauthn-doc.spomky-labs.com moves from hosting.gitbook.com to web-auth.github.io; the domain is declared, then HTTPS enforced.