docs: update stale README + env docs for better-auth#300
Merged
Conversation
- README: rewrite auth section for better-auth (login / reset-password / accept-invitation, _authenticated guard, useAuth/authClient); drop dead Auth0, ProtectedRoute, and broken AUTH_SETUP.md references; fix Node version 22.15.x -> 24.13.x - environment-config: replace broken 2-row table with the full 6 vars; fix config.monitoring.appInsightsConnectionString accessor - .env.example: remove dead VITE_APP_INSIGHTS_KEY
There was a problem hiding this comment.
Pull request overview
Updates project documentation to reflect the current better-auth-based authentication flow and the actual set of required client-side environment variables (including correcting the documented Node.js version to match repo configuration).
Changes:
- Rewrites
README.mdAuthentication section from Auth0 to better-auth (routes, session APIs, and guard behavior) and updates Node.js prerequisites to 24.13.x. - Fixes
docs/environment-config.mdto list all requiredVITE_*variables and corrects the monitoring config property name. - Removes unused
VITE_APP_INSIGHTS_KEYfrom.env.example.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Updates auth documentation to better-auth and corrects Node version references. |
| docs/environment-config.md | Expands env var documentation to the full required set and fixes config property naming. |
| .env.example | Removes the dead VITE_APP_INSIGHTS_KEY variable. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Clarify that returnTo carries the full URL, not just the path - List all required env vars in Quick Start to avoid startup config error Refs: #300
kaseywright
approved these changes
Jun 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Updates documentation that had drifted from the implementation.
Changes
/login,/reset-password,/accept-invitation, the_authenticatedroute guard,useAuth()/authClient). Removed the deadProtectedRoutemention and the brokendocs/AUTH_SETUP.mdlink. Switched the Features and Technologies entries from Auth0 → better-auth. Corrected the Node version (22.15.x/22.15.0→24.13.x/24.13.0) to matchpackage.jsonenginesand.nvmrc.VITE_API_URL,VITE_ENVIRONMENT,VITE_BETTER_AUTH_URL,VITE_AQUIFER_API_URL,VITE_AQUIFER_API_KEY, and optionalVITE_APP_INSIGHTS_CONNECTION_STRING). Fixed theconfig.monitoring.appInsightsKey→appInsightsConnectionStringreference.VITE_APP_INSIGHTS_KEY.Notes
The Node-version fix wasn't in the ticket's original 3-item list but is the same "stale docs" class — flagged in a ticket comment. Docs-only change; no code touched. Auth content verified against
src/lib/auth-client.ts,src/hooks/useAuth.ts,src/routes/_authenticated.tsx, andsrc/features/auth/*; the env table verified againstsrc/lib/config.ts.Closes #294