chore: add README for better-auth adapter

[ymc9]

Summary by CodeRabbit

• Documentation
  • Added README for the Better-Auth Adapter outlining installation, configuration with provider setup, and guidance for generating required schema artifacts.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

A README.md was added to the ZenStack Better-Auth Adapter package documenting installation, configuration (including a zenstackAdapter snippet and PostgreSQL provider example), and schema generation via @better-auth/cli. No code or behavior changes.

Changes

Cohort / File(s)	Change Summary
Documentation packages/auth-adapters/better-auth/README.md	Added new README with installation steps, configuration example using zenstackAdapter, PostgreSQL provider setup, and guidance to generate schemas with @better-auth/cli.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Documentation-only change; review for clarity and correctness of code snippet and CLI instructions.

Possibly related PRs

• chore: add README for better-auth adapter #425 — Adds the same packages/auth-adapters/better-auth/README.md documentation file (directly related duplicate/addition).

Poem

🐰 I hopped a README into view,
Steps for install and setup, too.
Config, Postgres, schemas clear —
A tiny guide for folks who're near.
Happy hopping, docs appear! ✨

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 'chore: add README for better-auth adapter' directly and accurately summarizes the main change—adding a README file for the better-auth adapter. It is specific, concise, and clearly communicates the primary modification.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d8997fe and 1dce5c5.

📒 Files selected for processing (1)

• packages/auth-adapters/better-auth/README.md (1 hunks)

---

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

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

[claude]

Claude finished @ymc9's task —— View job

---

Code Review for Better Auth Adapter README

Todo List:

• Read and analyze the new README file
• Review documentation quality and completeness
• Check for best practices and accuracy
• Provide comprehensive feedback

---

Review Summary

I've reviewed the new README file for the Better Auth adapter. Overall, it's a good start but needs several improvements to match documentation standards and provide complete guidance for users.

Code Quality & Best Practices

✅ Strengths:

• Clear, concise structure following standard README conventions
• Proper code syntax highlighting with TypeScript examples
• Matches the package name from package.json correctly
• Installation command references the correct package name

⚠️ Areas for Improvement:

Issues Found

1. Installation Command Inconsistency

File: packages/auth-adapters/better-auth/README.md:8

npm install @zenstackhq/better-auth@next

Issue: The installation command uses @next tag, which should be consistent with project conventions. Based on the main README, ZenStack v3 packages use @next tag, so this is correct, but it should be documented why.

2. Missing Import Statement

File: packages/auth-adapters/better-auth/README.md:19

The configuration example references BetterAuth but doesn't show where to import it from:

const auth = new BetterAuth({  // ← Missing import

Fix needed: Add the missing import:

import { BetterAuth } from 'better-auth';
import { zenstackAdapter } from '@zenstackhq/better-auth';

3. Incomplete Documentation

Missing sections:

• Prerequisites: Should mention required dependencies (better-auth, @better-auth/core)
• Database Setup: No guidance on database schema setup
• ZenStack Client Setup: The example assumes db exists but doesn't explain how to create it
• Error Handling: No mention of common issues or troubleshooting
• API Reference: No documentation of AdapterConfig options beyond provider

4. Schema Generation Section Issues

File: packages/auth-adapters/better-auth/README.md:29

• Typo: "into you ZModel schema" should be "into your ZModel schema"
• Missing context about what this command does
• No explanation of the relationship between Better Auth models and ZenStack schema

5. Configuration Options

The adapter supports more options than shown (based on AdapterConfig interface):

• debugLogs option not documented
• usePlural option not documented

Security Considerations

✅ No security issues found - The configuration examples don't expose any sensitive information and follow standard patterns.

Performance Considerations

✅ No performance concerns - The documentation doesn't introduce any performance-impacting patterns.

Test Coverage

⚠️ Missing: No examples of how to test applications using this adapter or any testing considerations.

Recommended Improvements

1. Add comprehensive prerequisites section
2. Include complete working example with ZenStack client setup
3. Document all configuration options with examples
4. Add troubleshooting section
5. Fix typo in schema generation section
6. Add missing imports in code examples
7. Explain Better Auth CLI integration more thoroughly

Overall Assessment

This README provides a basic foundation but needs significant expansion to be production-ready documentation. The code examples are syntactically correct but incomplete, potentially leaving developers confused about setup requirements.

Recommendation: Expand the documentation significantly before merging, or consider this a first iteration that will need follow-up improvements.

---

[Copilot]

Pull Request Overview

This PR adds a README file for the ZenStack Better-Auth adapter package, providing essential documentation for users who want to integrate ZenStack ORM with better-auth for authentication.

• Introduces installation instructions for the adapter package
• Provides a configuration example showing how to use the ZenStack adapter
• Includes schema generation guidance using better-auth CLI

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 710cb8b and d8997fe.

📒 Files selected for processing (1)

• packages/auth-adapters/better-auth/README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

packages/auth-adapters/better-auth/README.md

[grammar] ~29-~29: Ensure spelling is correct
Context: ...populate better-auth's data models into you ZModel schema. ```bash npx @better-aut...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: build-test (20.x, sqlite)
• GitHub Check: build-test (20.x, postgresql)

🔇 Additional comments (1)

packages/auth-adapters/better-auth/README.md (1)

8-8: Verify the package version reference.

Confirm that installing with the @next tag is the intended approach for users. If this package is production-ready, consider using a stable version (e.g., @latest) or a specific semver range instead of @next.

[claude]

Claude finished @ymc9's task —— View job

---

Code Review for Better Auth Adapter README

Todo List:

• Read and analyze the new README file
• Review documentation quality and completeness
• Check for best practices and accuracy
• Provide comprehensive feedback

---

Review Summary

I've reviewed the new README file for the Better Auth adapter. Overall, it's a good start but needs several improvements to match documentation standards and provide complete guidance for users.

Code Quality & Best Practices

✅ Strengths:

• Clear, concise structure following standard README conventions
• Proper code syntax highlighting with TypeScript examples
• Matches the package name from package.json correctly
• Installation command references the correct package name

⚠️ Areas for Improvement:

Issues Found

1. Installation Command Inconsistency

File: packages/auth-adapters/better-auth/README.md:8

npm install @zenstackhq/better-auth@next

Issue: The installation command uses @next tag, which should be consistent with project conventions. Based on the main README, ZenStack v3 packages use @next tag, so this is correct, but it should be documented why.

2. Missing Import Statement

File: packages/auth-adapters/better-auth/README.md:19

The configuration example references BetterAuth but doesn't show where to import it from:

const auth = new BetterAuth({  // ← Missing import

Fix needed: Add the missing import:

import { BetterAuth } from 'better-auth';
import { zenstackAdapter } from '@zenstackhq/better-auth';

3. Incomplete Documentation

Missing sections:

• Prerequisites: Should mention required dependencies (better-auth, @better-auth/core)
• Database Setup: No guidance on database schema setup
• ZenStack Client Setup: The example assumes db exists but doesn't explain how to create it
• Error Handling: No mention of common issues or troubleshooting
• API Reference: No documentation of AdapterConfig options beyond provider

4. Schema Generation Section Issues

File: packages/auth-adapters/better-auth/README.md:29

• Typo: "into you ZModel schema" should be "into your ZModel schema"
• Missing context about what this command does
• No explanation of the relationship between Better Auth models and ZenStack schema

5. Configuration Options

The adapter supports more options than shown (based on AdapterConfig interface):

• debugLogs option not documented
• usePlural option not documented

Security Considerations

✅ No security issues found - The configuration examples don't expose any sensitive information and follow standard patterns.

Performance Considerations

✅ No performance concerns - The documentation doesn't introduce any performance-impacting patterns.

Test Coverage

⚠️ Missing: No examples of how to test applications using this adapter or any testing considerations.

Recommended Improvements

1. Add comprehensive prerequisites section
2. Include complete working example with ZenStack client setup
3. Document all configuration options with examples
4. Add troubleshooting section
5. Fix typo in schema generation section
6. Add missing imports in code examples
7. Explain Better Auth CLI integration more thoroughly

Overall Assessment

This README provides a basic foundation but needs significant expansion to be production-ready documentation. The code examples are syntactically correct but incomplete, potentially leaving developers confused about setup requirements.

Recommendation: Expand the documentation significantly before merging, or consider this a first iteration that will need follow-up improvements.

---