github-starred/better-auth
2
0
Fork 0
mirror of https://github.com/better-auth/better-auth.git synced 2026-05-22 14:21:55 -05:00
Code Issues 2.5k Packages Projects Releases 112 Wiki Activity

[PR #4366] [MERGED] docs: add orama search support #13581

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

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/4366
Author: @himself65
Created: 9/2/2025
Status: ✅ Merged
Merged: 9/2/2025
Merged by: @himself65

Base: canary ← Head: himself65/2025/09/02/search

📝 Commits (4)

📊 Changes

9 files changed (+344 additions, -14 deletions)

View changed files

📝 docs/.env.example (+7 -1)
📝 docs/app/layout.tsx (+5 -0)
➕ docs/app/static.json/route.ts (+7 -0)
➕ docs/components/search-dialog.tsx (+59 -0)
➕ docs/lib/export-search-indexes.ts (+14 -0)
📝 docs/package.json (+4 -2)
➕ docs/scripts/sync-orama.ts (+30 -0)
📝 docs/turbo.json (+7 -1)
📝 pnpm-lock.yaml (+211 -10)

📄 Description

before:
image

after:

image

Summary by cubic

Add Orama Cloud search to the docs with a custom search dialog and an automated index sync during build. This improves search relevance and keeps the index up to date.

  • New Features

    • CustomSearchDialog wired into the layout to enable search in the docs UI.
    • Orama Cloud client integration via fumadocs “orama-cloud” search.
    • Static index export at /static.json using site content (no revalidate).
    • Build runs scripts:sync-orama to push records to Orama (auto-deploy if keys set).
    • .env.example updated with ORAMA_PRIVATE_API_KEY, NEXT_PUBLIC_ORAMA_PUBLIC_API_KEY, NEXT_PUBLIC_ORAMA_ENDPOINT, ORAMA_INDEX_ID.
    • Added @oramacloud/client dependency.

  • Migration

    • Create an Orama index and set in docs/.env:
      • ORAMA_PRIVATE_API_KEY, NEXT_PUBLIC_ORAMA_PUBLIC_API_KEY, NEXT_PUBLIC_ORAMA_ENDPOINT, ORAMA_INDEX_ID
    • pnpm install, then build the docs (build triggers sync). If no private key is set, sync is skipped.

🔄 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/4366 **Author:** [@himself65](https://github.com/himself65) **Created:** 9/2/2025 **Status:** ✅ Merged **Merged:** 9/2/2025 **Merged by:** [@himself65](https://github.com/himself65) **Base:** `canary` ← **Head:** `himself65/2025/09/02/search` --- ### 📝 Commits (4) - [`28899a0`](https://github.com/better-auth/better-auth/commit/28899a0d0e391c9bc4bde5528bdc5fb1b9b513fd) docs: add orama search support - [`380a6f9`](https://github.com/better-auth/better-auth/commit/380a6f9658e870e8fa312c7bffe8d4eabb194d90) docs: fix script - [`49177fa`](https://github.com/better-auth/better-auth/commit/49177fac7ab49ab9bc90163ca25a951513da79a1) fix: turbo.json - [`4ae58fc`](https://github.com/better-auth/better-auth/commit/4ae58fcf057feae87de76aabd74a93593f29ade8) fix: dot env ### 📊 Changes **9 files changed** (+344 additions, -14 deletions) <details> <summary>View changed files</summary> 📝 `docs/.env.example` (+7 -1) 📝 `docs/app/layout.tsx` (+5 -0) ➕ `docs/app/static.json/route.ts` (+7 -0) ➕ `docs/components/search-dialog.tsx` (+59 -0) ➕ `docs/lib/export-search-indexes.ts` (+14 -0) 📝 `docs/package.json` (+4 -2) ➕ `docs/scripts/sync-orama.ts` (+30 -0) 📝 `docs/turbo.json` (+7 -1) 📝 `pnpm-lock.yaml` (+211 -10) </details> ### 📄 Description before: <img width="867" height="599" alt="image" src="https://github.com/user-attachments/assets/0f749b80-97d7-4695-8fe1-4103abb7986d" /> after: <img width="750" height="483" alt="image" src="https://github.com/user-attachments/assets/ef7830f7-9f4e-45b0-a319-0c099ff297bb" /> <!-- This is an auto-generated description by cubic. --> ## Summary by cubic Add Orama Cloud search to the docs with a custom search dialog and an automated index sync during build. This improves search relevance and keeps the index up to date. - **New Features** - CustomSearchDialog wired into the layout to enable search in the docs UI. - Orama Cloud client integration via fumadocs “orama-cloud” search. - Static index export at /static.json using site content (no revalidate). - Build runs scripts:sync-orama to push records to Orama (auto-deploy if keys set). - .env.example updated with ORAMA_PRIVATE_API_KEY, NEXT_PUBLIC_ORAMA_PUBLIC_API_KEY, NEXT_PUBLIC_ORAMA_ENDPOINT, ORAMA_INDEX_ID. - Added @oramacloud/client dependency. - **Migration** - Create an Orama index and set in docs/.env: - ORAMA_PRIVATE_API_KEY, NEXT_PUBLIC_ORAMA_PUBLIC_API_KEY, NEXT_PUBLIC_ORAMA_ENDPOINT, ORAMA_INDEX_ID - pnpm install, then build the docs (build triggers sync). If no private key is set, sync is skipped. <!-- 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 09:00:52 -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#13581
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?