Skip to content

Conversation

eastgold15
Copy link

@eastgold15 eastgold15 commented Oct 14, 2025

Summary

  • Fix code block formatting in better-auth.md documentation
  • Add proper code highlighting for openAPI plugin usage example
  • Improve readability of the integration example

Test plan

  • Review the documentation changes in better-auth.md
  • Verify code blocks are properly formatted and highlighted
  • Check that the example is clear and easy to follow

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Added an integration example showing how to enable the OpenAPI plugin for Better Auth, clarified import/usage patterns, and updated the OpenAPI schema generation workflow.
    • Clarified handler example by including an explicit http:// URL prefix for running URLs.
  • Chores

    • Added ignore rule to exclude local Obsidian directories from the repository.

- Fix code block formatting in better-auth.md
- Add proper code highlighting for openAPI plugin usage

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Copy link
Contributor

coderabbitai bot commented Oct 14, 2025

Walkthrough

Updated documentation: the Better Auth integration example now shows using openAPI() from better-auth/plugins; the Handler example URL includes an http:// prefix. Added .obsidian/* to .gitignore.

Changes

Cohort / File(s) Summary
Docs: Better Auth + OpenAPI example
docs/integrations/better-auth.md
Updated example to import openAPI from better-auth/plugins, configure betterAuth({ plugins: [openAPI()] }), and added http:// prefix in the Handler example URL.
Repo: ignore Obsidian dirs
.gitignore
Added rule to ignore Obsidian workspace directories: .obsidian/*.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I nibble at docs with careful cheer,
A plugin hop draws schema near.
URLs shine with their proper scheme,
Obsidian hidden, tidy dream.
🥕 Thump—updates done, neat and dear.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "docs: fix code block formatting in better-auth integration" is directly related to the primary changes in the pull request. The main modifications are in the better-auth.md documentation file, where code examples have been updated with improved formatting (adding http:// prefix) and new OpenAPI plugin integration examples have been added with proper syntax highlighting. The title accurately reflects these documentation improvements and is specific enough to indicate the file affected and the nature of the changes. While the PR also includes a minor unrelated change to .gitignore, the title appropriately focuses on the primary objective of the documentation enhancement.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 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 acb9be2 and fe0d7a2.

📒 Files selected for processing (2)
  • .gitignore (1 hunks)
  • docs/integrations/better-auth.md (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .gitignore
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/integrations/better-auth.md

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3d2186d and acb9be2.

📒 Files selected for processing (1)
  • docs/integrations/better-auth.md (1 hunks)

Added .obsidian/ to .gitignore to exclude Obsidian workspace files. Improved documentation for better-auth integration by correcting the server URL format and reorganizing plugin import statements for clarity.
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.

1 participant