From b4272b981103c346c197deded80434e417bff556 Mon Sep 17 00:00:00 2001 From: Florent Morselli Date: Sun, 25 Oct 2026 22:58:11 +0100 Subject: [PATCH 1/3] docs: the home page and the site carry the name of the project The Slabs guidelines name the project WebAuthn Framework: the title of the home page, the name of the site in the tabs of the browser and the link of the footer say it, as the project mark of the header does. --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 80bab4e..8d63b3a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ description: >- Tutorials --- -# WebAuthn: Strong authentication for your PHP applications +# WebAuthn Framework Welcome to WebAuthn, the solution for strong authentication on the web. With WebAuthn, you can offer your users a secure, simple, and convenient authentication experience that seamlessly integrates with your PHP or Symfony application. From ed581390dade447cf02bd77fa4fdda1733db6ae8 Mon Sep 17 00:00:00 2001 From: Florent Morselli Date: Sun, 25 Oct 2026 22:58:11 +0100 Subject: [PATCH 2/3] chore: the GitBook space is gone, and its table of contents with it The domain points to GitHub Pages: the files that kept GitBook working go. The navigation of mkdocs.yml is the only table of contents. --- .gitbook.yaml | 7 ----- README.md | 1 - docs/SUMMARY.md | 79 ------------------------------------------------- mkdocs.yml | 4 --- 4 files changed, 91 deletions(-) delete mode 100644 .gitbook.yaml delete mode 100644 docs/SUMMARY.md diff --git a/.gitbook.yaml b/.gitbook.yaml deleted file mode 100644 index 3b0a865..0000000 --- a/.gitbook.yaml +++ /dev/null @@ -1,7 +0,0 @@ -# GitBook serves the domain until it points to GitHub Pages. The pages moved to docs/ for MkDocs, and this -# tells GitBook where they are. It goes away with the GitBook space. -root: ./docs/ - -structure: - readme: README.md - summary: SUMMARY.md diff --git a/README.md b/README.md index 65a6fcf..9ffc584 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,6 @@ navigation or a navigation entry without a page fails the build. | `.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 | -| `docs/SUMMARY.md`, `.gitbook.yaml` | The GitBook space, until the domain points to GitHub Pages | How the documentation left GitBook, and the rules every documentation site of Slabs follows, are in [Spomky-Labs/docs](https://github.com/Spomky-Labs/docs/blob/main/MIGRATING.md). diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md deleted file mode 100644 index aabbd87..0000000 --- a/docs/SUMMARY.md +++ /dev/null @@ -1,79 +0,0 @@ -# Table of contents - -* [WebAuthn: Strong Authentication for your PHP applications](README.md) - -## The project - -* [What is WebAuthn?](the-project/the-project.md) -* [Web Browser Support](the-project/web-browser-support.md) -* [Installation](the-project/installation.md) -* [Demos](the-project/demos.md) -* [Contributing](the-project/contributing.md) - -## WebAuthn In A Nutshell - -* [Authenticators](webauthn-in-a-nutshell/authenticators.md) -* [Ceremonies](webauthn-in-a-nutshell/ceremonies.md) -* [User Verification](webauthn-in-a-nutshell/user-verification.md) -* [Metadata Statement](webauthn-in-a-nutshell/attestation-and-metadata-statement.md) -* [Extensions](webauthn-in-a-nutshell/extensions.md) - -## Prerequisites - -* [The Relying Party](prerequisites/the-relying-party.md) -* [Credential Record](prerequisites/credential-record.md) -* [User Entity](prerequisites/user-entity.md) -* [JavaScript](prerequisites/javascript.md) - -## Pure PHP - -* [WebAuthn Server](pure-php/webauthn-server.md) -* [Input Loading](pure-php/input-loading.md) -* [Input Validation](pure-php/input-validation.md) -* [Register Authenticators](pure-php/authenticator-registration.md) -* [Authenticate Your Users](pure-php/authenticate-your-users.md) -* [Advanced Behaviors](pure-php/advanced-behaviours/README.md) - * [Debugging](pure-php/advanced-behaviours/debugging.md) - * [User Verification](pure-php/advanced-behaviours/user-verification.md) - * [Authenticator Selection Criteria](pure-php/advanced-behaviours/authenticator-selection-criteria.md) - * [Authentication without username](pure-php/advanced-behaviours/authentication-without-username.md) - * [Authenticator Algorithms](pure-php/advanced-behaviours/authenticator-algorithms.md) - * [Attestation and Metadata Statement](pure-php/advanced-behaviours/attestation-and-metadata-statement.md) - * [Extensions](pure-php/advanced-behaviours/extensions.md) - * [Authenticator Counter](pure-php/advanced-behaviours/authenticator-counter.md) - * [Cross Origin Authentication](pure-php/advanced-behaviours/cross-origin-authentication.md) - * [Signal API](pure-php/advanced-behaviours/signal-api.md) - * [Backup Events](pure-php/advanced-behaviours/backup-events.md) - * [Conditional Create](pure-php/advanced-behaviours/conditional-create.md) - -## Symfony Bundle - -* [Bundle Installation](symfony-bundle/bundle-installation.md) -* [Credential Record Repository](symfony-bundle/credential-record-repository.md) -* [User Entity Repository](symfony-bundle/user-entity-repository.md) -* [Firewall](symfony-bundle/firewall.md) -* [Configuration References](symfony-bundle/configuration-references.md) -* [Advanced Behaviors](symfony-bundle/advanced-behaviors/README.md) - * [Fake Credentials](symfony-bundle/advanced-behaviors/fake-credentials.md) - * [Register Additional Authenticators](symfony-bundle/advanced-behaviors/register-authenticators.md) - * [Debugging](symfony-bundle/advanced-behaviors/debugging.md) - * [User Verification](symfony-bundle/advanced-behaviors/user-verification.md) - * [Attestation and Metadata Statement](symfony-bundle/advanced-behaviors/attestation-and-metadata-statement.md) - * [Authenticator Selection Criteria](symfony-bundle/advanced-behaviors/authenticator-selection-criteria.md) - * [Authentication without username](symfony-bundle/advanced-behaviors/authentication-without-username.md) - * [Extensions](symfony-bundle/advanced-behaviors/extensions.md) - * [Authenticator Counter](symfony-bundle/advanced-behaviors/authenticator-counter.md) - * [Cross Origin Authentication](symfony-bundle/advanced-behaviors/cross-origin-authentication.md) - * [Client Override Policy](symfony-bundle/advanced-behaviors/client-override-policy.md) - * [Passkey Endpoints](symfony-bundle/advanced-behaviors/passkey-endpoints.md) - -## Migration - -* [From 5.x to 6.0](migration/from-v5.x-to-v6.0.md) - -## Symfony UX - -* [Installation](symfony-ux/installation.md) -* [User Authentication](symfony-ux/user-authentication.md) -* [User Registration](symfony-ux/user-registration.md) -* [Additional Authenticators](symfony-ux/additional-authenticators.md) diff --git a/mkdocs.yml b/mkdocs.yml index 9c195cb..5c2425a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,10 +9,6 @@ edit_uri: https://github.com/web-auth/doc/edit/5.3/docs/ docs_dir: docs site_dir: site -# The GitBook table of contents. It stays while GitBook serves the domain, and the navigation below says the -# same thing in the words of MkDocs. -exclude_docs: | - SUMMARY.md theme: name: material From 59096b8db7d2f5c371278d8cba7857458b8b399c Mon Sep 17 00:00:00 2001 From: Florent Morselli Date: Sun, 25 Oct 2026 22:58:11 +0100 Subject: [PATCH 3/3] fix: a branch left from GitBook does not take latest A branch without mkdocs.yml is not a published version: when it looks for the newest version branch, pages.yml now keeps only the branches that hold one. A branch left from GitBook took latest from 1.6 on the documentation of PWA Bundle. --- .github/workflows/pages.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 745da95..b2ab2c6 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -65,13 +65,15 @@ jobs: # The highest version branch of the repository, by version order, in which a "1.x" branch comes # after "1.2" and "1.2.x": it is where the next minor is written. sort -V alone puts "1.x" first, - # so each name is sorted by a key where "x" is a large number. Only that branch carries "latest". + # so each name is sorted by a key where "x" is a large number. A branch without mkdocs.yml is not a + # published version (a branch left from GitBook). Only that branch carries "latest". - name: Is this the newest version? id: newest run: | git fetch --quiet origin '+refs/heads/*:refs/remotes/origin/*' newest=$(git for-each-ref --format='%(refname:lstrip=3)' 'refs/remotes/origin/*' \ | grep -E '^[0-9]+\.([0-9]+(\.x)?|x)$' \ + | while read -r branch; do git cat-file -e "origin/$branch:mkdocs.yml" 2>/dev/null && echo "$branch"; done \ | awk '{ key = $0; if (key ~ /^[0-9]+\.x$/) sub(/x$/, "999999", key); else sub(/\.x$/, "", key); print key " " $0 }' \ | sort -V -k1,1 \ | tail -n 1 \