github-starred/better-auth
2
0
Fork 0
mirror of https://github.com/better-auth/better-auth.git synced 2026-05-24 08:01:56 -05:00
Code Issues 2.5k Packages Projects Releases 112 Wiki Activity

[PR #8935] [MERGED] docs: improve descriptions for appName, trustedOrigins, useSecureCookies #16553

New Issue
Closed
opened 2026-04-13 10:34:22 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-13 10:34:22 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/8935
Author: @wobedi
Created: 4/3/2026
Status: ✅ Merged
Merged: 4/3/2026
Merged by: @ping-maxwell

Base: main ← Head: docs/improve-appname-description

📝 Commits (5)

  • 6f5069d docs: expand appName description with actual usage context
  • cc42e58 docs: clarify that trustedOrigins is additive to baseURL
  • a898656 docs: clarify useSecureCookies default behavior
  • 7d1eec6 docs: update JSDoc for appName, trustedOrigins, useSecureCookies
  • ee8af2b docs: fix spell check and improve useSecureCookies accuracy

📊 Changes

2 files changed (+18 additions, -7 deletions)

View changed files

📝 docs/content/docs/reference/options.mdx (+5 -3)
📝 packages/core/src/types/init-options.ts (+13 -4)

📄 Description

Summary

Some parts of the docs/intellisense tripped me up - trying to make them clearer.

  • appName: Explain that it's used as the default issuer name in authenticator apps for 2FA/TOTP, not just "the name of the application"
  • trustedOrigins: Clarify that baseURL is trusted by default and this option specifies additional origins
  • useSecureCookies: Clarify that cookies are already secure in production by default — this option forces the Secure attribute in all environments

Updates both the docs reference page (docs/content/docs/reference/options.mdx) and the TypeScript JSDoc comments (packages/core/src/types/init-options.ts) so the improved descriptions also show on hover in editors.

Summary by cubic

Clarify appName, trustedOrigins, and useSecureCookies in docs and JSDoc, and fix a spell-check issue, so usage and defaults are accurate.

appName is the default issuer for 2FA/TOTP; trustedOrigins adds to baseURL; useSecureCookies forces Secure cookies in all environments (cookies are already secure in production).

Written for commit ee8af2beab. Summary will update on new commits.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/better-auth/better-auth/pull/8935 **Author:** [@wobedi](https://github.com/wobedi) **Created:** 4/3/2026 **Status:** ✅ Merged **Merged:** 4/3/2026 **Merged by:** [@ping-maxwell](https://github.com/ping-maxwell) **Base:** `main` ← **Head:** `docs/improve-appname-description` --- ### 📝 Commits (5) - [`6f5069d`](https://github.com/better-auth/better-auth/commit/6f5069d488bd81ea842cbc3ad4fc527bb762aa45) docs: expand appName description with actual usage context - [`cc42e58`](https://github.com/better-auth/better-auth/commit/cc42e58b9cba44dc6c9ecfac4806716297854f3c) docs: clarify that trustedOrigins is additive to baseURL - [`a898656`](https://github.com/better-auth/better-auth/commit/a898656a8c7ce4ab21e636cb6d0f65a17df757ac) docs: clarify useSecureCookies default behavior - [`7d1eec6`](https://github.com/better-auth/better-auth/commit/7d1eec6476eaac2f27ca8a206252186b0264b241) docs: update JSDoc for appName, trustedOrigins, useSecureCookies - [`ee8af2b`](https://github.com/better-auth/better-auth/commit/ee8af2beabbc58056534c69cda0a9cf6a7989587) docs: fix spell check and improve useSecureCookies accuracy ### 📊 Changes **2 files changed** (+18 additions, -7 deletions) <details> <summary>View changed files</summary> 📝 `docs/content/docs/reference/options.mdx` (+5 -3) 📝 `packages/core/src/types/init-options.ts` (+13 -4) </details> ### 📄 Description ## Summary Some parts of the docs/intellisense tripped me up - trying to make them clearer. - **`appName`**: Explain that it's used as the default issuer name in authenticator apps for 2FA/TOTP, not just "the name of the application" - **`trustedOrigins`**: Clarify that `baseURL` is trusted by default and this option specifies *additional* origins - **`useSecureCookies`**: Clarify that cookies are already secure in production by default — this option forces the `Secure` attribute in all environments Updates both the docs reference page (`docs/content/docs/reference/options.mdx`) and the TypeScript JSDoc comments (`packages/core/src/types/init-options.ts`) so the improved descriptions also show on hover in editors. <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Clarify `appName`, `trustedOrigins`, and `useSecureCookies` in docs and JSDoc, and fix a spell-check issue, so usage and defaults are accurate. `appName` is the default issuer for 2FA/TOTP; `trustedOrigins` adds to `baseURL`; `useSecureCookies` forces Secure cookies in all environments (cookies are already secure in production). <sup>Written for commit ee8af2beabbc58056534c69cda0a9cf6a7989587. Summary will update on new commits.</sup> <!-- End of auto-generated description by cubic. --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-13 10:34:22 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
adapter
astro
awaiting external contributor
blocked
breaking
breaking change
bug
c-devops
core
credentials
database
dependencies
devops
devtools
docs
documentation
duplicate
elysia
enhancement
enterprise
expo
express
fastify
good first issue
help wanted
hono
identity
infra
integration
invalid
javascript
locked
maintenance
need-more-information
needs: info
needs: repro
nextjs
nuxt
oauth
organization
P0
payments
perf
platform
plugin
pull-request
Mirrored from GitHub Pull Request
 question
ready
regression
remix
security
social-provider
solid
stale
svelte
tanstack-start
tracking
version-bump
vue
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#16553
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?