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 example showing how to enable the OpenAPI plugin for Better Auth and clarified import/usage patterns; updated the OpenAPI schema generation workflow.
    • Clarified a handler example by including an explicit http:// URL prefix for running URLs.
    • Noted turbomonorepo support allowing the root path to be omitted in certain OpenAPI scenarios.
  • Chores

    • Added an 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 <noreply@anthropic.com>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 14, 2025

Walkthrough

Updated docs: Better Auth integration now shows using openAPI() from better-auth/plugins and the Handler URL includes an http:// prefix. OpenAPI caveat text updated to mention turbomonorepo root-path behavior. Added .obsidian/* to .gitignore.

Changes

Cohort / File(s) Summary
Docs: Better Auth + OpenAPI example
docs/integrations/better-auth.md
Import openAPI from better-auth/plugins, configure betterAuth({ plugins: [openAPI()] }), add http:// prefix to the Handler example URL, and adjust surrounding example to reflect plugin usage.
Docs: OpenAPI caveat note
docs/patterns/openapi.md
Clarified Caveats: Root path section to mention turbomonorepo support — root path can be omitted when using turbomonorepo; retained guidance about providing project root for correct generator operation.
Repo: ignore Obsidian dirs
.gitignore
Added .obsidian/* to ignore Obsidian workspace directories.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I nibble at docs with careful cheer,
A plugin hop draws schema near.
URLs gleam with their proper scheme,
Root paths noted in the stream.
🥕 Thump—quiet folders tucked from view.

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 PR title "docs: fix code block formatting in better-auth integration" is partially related to the changeset. It correctly identifies the primary file being modified (docs/integrations/better-auth.md) and references a real aspect of the changes (code formatting improvements). The main changes in better-auth.md include adding a new OpenAPI plugin integration code snippet with proper formatting and updating the running URL example. However, the title undersells the scope somewhat by framing the changes purely as "formatting fixes" when new content documentation is also being added, and it omits changes to .gitignore and docs/patterns/openapi.md. Despite these limitations, the title captures the primary focus of the changeset from the developer's perspective.
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 fe0d7a2 and d8c49cd.

📒 Files selected for processing (1)
  • docs/patterns/openapi.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/patterns/openapi.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.
turbomonorepo,no need root path
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