-
Notifications
You must be signed in to change notification settings - Fork 1
docs: comprehensive rewrite of authentication documentation #335
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Add hero section with full-stack auth snippets (Frontend/API/Agent) - Document default plugins (organization, jwt, bearer, apiKey) - Expand middleware docs with hasOrgRole, hasPermission options - Add full auth context (c.var.auth/ctx.auth) method reference - Document agent-to-agent auth propagation - Expand environment variables with defaults and auto-resolution - Add CLI commands reference (auth init, auth generate) - Link to BetterAuth docs for organization, API key, JWT plugins - Link to SDK testing app for complete examples
📝 WalkthroughWalkthroughThe authentication documentation is restructured to introduce a unified multi-tab narrative covering frontend, API, and agent contexts. Client-side auth examples are added (useAuth hook, helper functions), middleware and API key sections are expanded, and code examples are updated to reflect new public API patterns and type import paths. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 1✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
🧹 Recent nitpick comments
📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🔇 Additional comments (10)
✏️ Tip: You can disable this entire section by setting Comment |
Summary
Complete rewrite of the
@agentuity/authdocumentation to fix inaccuracies, add missing features, and improve developer experience.What Changed
hasOrgRole,hasPermission,optionaloptions now documentedc.var.auth/ctx.authmethodsctx.authinterface + agent-to-agent propagationinitandgeneratewith optionsWhy
The previous documentation had several issues:
Links Added
Size
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.