docs: update docs

[james-d-elliott]

This generally updates the documentation and specifically moves most of the documentation to the go doc.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce new and expanded documentation, including a breaking changes log, streamlined and clarified README, and comprehensive package-level usage guidance for the WebAuthn library. Three new example test files demonstrate multi-factor and passkey authentication flows, as well as relying party initialization. Additionally, utility functions for user management in tests are added.

Changes

Files/Group	Change Summary
BREAKING.md	New file documenting breaking changes, starting with backup flag validation in v0.11.0.
README.md	Significantly condensed; removed detailed examples, clarified features, added reference to breaking changes.
webauthn/doc.go	Expanded package-level documentation with detailed usage and recommended functions.
webauthn/example_multifactor_test.go	New example: multi-factor registration and login flows with handlers, session, and credential management.
webauthn/example_passkey_test.go	New example: passkey registration and login flows with handlers, session, and credential management.
webauthn/example_new_test.go	New example: demonstrates relying party initialization with basic config.
webauthn/util_test.go	New test utilities: user struct, user management functions for test scenarios.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Browser
    participant Server
    participant WebAuthnLib

    User->>Browser: Initiate Registration/Login
    Browser->>Server: Send request (start)
    Server->>WebAuthnLib: Begin[Registration/Login]
    WebAuthnLib-->>Server: Challenge + Session Data
    Server-->>Browser: Return Challenge
    Browser->>User: Prompt for Authenticator
    User->>Browser: Complete Auth
    Browser->>Server: Send response (finish)
    Server->>WebAuthnLib: Finish[Registration/Login] with response + session
    WebAuthnLib-->>Server: Validated Credential/Assertion
    Server-->>Browser: Success/Failure

Loading

Poem

🐇
Docs are tidier, concise and bright,
With new examples to guide you right.
Multi-factor, passkeys—flows on display,
Utility rabbits help you test and play.
Breaking changes now easy to see,
WebAuthn hopping to clarity!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between afa0309 and df5c2f4.

📒 Files selected for processing (7)

• BREAKING.md (1 hunks)
• README.md (3 hunks)
• webauthn/doc.go (1 hunks)
• webauthn/example_multifactor_test.go (1 hunks)
• webauthn/example_new_test.go (1 hunks)
• webauthn/example_passkey_test.go (1 hunks)
• webauthn/util_test.go (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.