Skip to content

docs: add DeviceAuthn enrollment and login sequence diagrams#2572

Open
gaultier wants to merge 4 commits into
masterfrom
pgaultier-deviceauthn-sequence-diagrams
Open

docs: add DeviceAuthn enrollment and login sequence diagrams#2572
gaultier wants to merge 4 commits into
masterfrom
pgaultier-deviceauthn-sequence-diagrams

Conversation

@gaultier
Copy link
Copy Markdown
Contributor

@gaultier gaultier commented May 21, 2026

Screenshot 2026-05-21 at 15 53 10

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 via mermaid.ink static image URLs (matching the existing pattern in docs/oathkeeper/index.mdx, since @docusaurus/theme-mermaid is not registered)

Test plan

  • npm run start and verify both diagrams render as images in the "Enrollment" and "Proof of device enrollment" sections.
  • Click the diagrams and confirm they open the editable version on mermaid.live.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Chores
    • Updated code formatter configuration to exclude a specific directory from formatting operations.

Review Change Stack

@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 PR description is primarily a screenshot and diagram links with minimal explanatory text; it lacks required sections from the template like Related Issue/Design Document, Checklist completion, and substantive justification. Provide the description following the template: include a summary of changes, reference the related design document or issue, complete the checklist items, and explain the rationale for the changes.
✅ 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants