Skip to content

docs: add DeviceAuthn enrollment and login sequence diagrams#2572

Merged
gaultier merged 5 commits into
masterfrom
pgaultier-deviceauthn-sequence-diagrams
May 22, 2026
Merged

docs: add DeviceAuthn enrollment and login sequence diagrams#2572
gaultier merged 5 commits into
masterfrom
pgaultier-deviceauthn-sequence-diagrams

Conversation

@gaultier
Copy link
Copy Markdown
Contributor

@gaultier gaultier commented May 21, 2026

Summary

  • Add two mermaid sequence diagrams to docs/kratos/passwordless/08_deviceauthn.mdx: one for enrolling a DeviceAuthn key (settings flow) and one for using an existing key to step up AAL (login flow).
  • Diagrams are rendered inline via the existing <Mermaid chart={...}> component (@site/src/theme/Mermaid), matching the pattern used in docs/kratos/quickstart.mdx. The mermaid source lives directly in the MDX file.

Test plan

  • npm run start and verify both diagrams render in the "Enrollment" and "Proof of device enrollment" sections.

🤖 Generated with Claude Code

@gaultier gaultier changed the title docs(kratos): add DeviceAuthn enrollment and login sequence diagrams docs: add DeviceAuthn enrollment and login sequence diagrams May 21, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 21, 2026

📝 Walkthrough

Walkthrough

The .prettierignore file is updated to add a single ignore pattern, .claude, which prevents Prettier from formatting files or directories matching that path.

Changes

Prettier Configuration Update

Layer / File(s) Summary
Exclude .claude from formatting
.prettierignore
The .claude directory/file is added to Prettier's ignore patterns, preventing the formatter from processing matching paths.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • aeneasr
  • zepatrik
  • piotrmsc
  • vinckr
  • unatasha8

Poem

A rabbit's whisker twitches with delight,
One line of code, so tiny and so right,
.claude joins the ignore list with care,
Prettier knows now: don't format me there! 🐰

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is substantially incomplete and misaligned with the actual changes. The summary describes adding mermaid diagrams to deviceauthn documentation, but the raw_summary shows only a .prettierignore file was modified. Clarify whether the PR description matches the actual changes. If the description is correct, ensure all changed files are included in the raw_summary. If the raw_summary is correct, update the PR description to accurately reflect that only .prettierignore was modified.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The PR title mentions adding DeviceAuthn sequence diagrams to documentation, which aligns with the primary change of adding two sequence diagrams to the docs/kratos/passwordless/08_deviceauthn.mdx file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch pgaultier-deviceauthn-sequence-diagrams

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Replace the mermaid.ink static images with <Mermaid chart={...}> using
@site/src/theme/Mermaid, matching the inline pattern from
docs/kratos/quickstart.mdx. Keeps the source visible in the file and
removes the dependency on the external mermaid.ink renderer.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@gaultier gaultier merged commit 1d8b87e into master May 22, 2026
12 checks passed
@gaultier gaultier deleted the pgaultier-deviceauthn-sequence-diagrams branch May 22, 2026 11:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants