Commit Graph
28 Commits
Author SHA1 Message Date
ce5cce5030 replace github discussions with local guides in the docs search (#42335)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

feature

## What is the current behavior?

Currently, old GitHub discussions appear in the docs search instead of
troubleshooting guides in docs/guides/troubleshooting

## What is the new behavior?

Local troubleshooting guides appear in the search

## Additional context

<img width="958" height="846" alt="CleanShot 2026-01-31 at 23 37 33@2x"
src="https://github.com/user-attachments/assets/445fab5d-764a-4b4d-b4ef-c29ab675a9ae"
/>


**troubleshooting.ts** - New source loader that reads local MDX files
from content/troubleshooting/ directly instead of fetching from GitHub
Discussions API
- Generates correct docs paths: /guides/troubleshooting/{slug}
- Uses type = 'troubleshooting' for proper search result mapping
- Sets slug: undefined to avoid trailing # in URLs
- Checksum includes title/topics/keywords so metadata-only changes
trigger re-indexing
- Left comments for review 

**index.ts** - Replaced GitHub discussion sources with local
troubleshooting sources
- Removed GitHubDiscussionLoader, fetchDiscussions,
buildGithubUrlToSlugMap imports
- Added fetchTroubleshootingSources and TroubleshootingSource
- Updated SearchSource type union

**globalSearchModel.ts** - Changed type mapping from
'github-discussions' to 'troubleshooting'

**generate-embeddings.ts** - Removed GitHub App env vars from required
list (DOCS_GITHUB_APP_ID, DOCS_GITHUB_APP_INSTALLATION_ID,
DOCS_GITHUB_APP_PRIVATE_KEY) since they're no longer needed


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Local troubleshooting articles are now indexed and appear directly in
search results for easier access to step‑by‑step guidance.
* Search UI now recognizes a Troubleshooting page type and shows
appropriate icons/sections.

* **Refactor**
* Search sourcing switched from external discussion feeds to local
troubleshooting sources to improve relevance and indexing consistency.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Illia Basalaiev <illiab@IMB3.local>
Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-02-23 13:54:40 +01:00
Charis fd308c6bad fix: search and sync scripts (#38756)
* fix: search script

* fix: sync script
2025-09-17 11:20:43 -04:00
Charis 8cd5e10038 feat: alternate search index for nimbus (#38662)
* feat: alternate search index for nimbus

Create an alternate search index for Nimbus that filters out
feature-flagged pages (equivalent to setting all feature flags to
false).

Notes:
- Creates two new DB tables, `page_nimbus` and `page_section_nimbus`,
  which are filtered versions of `page` and `page_section`
- Makes `nimbus` versions of all the DB search functions
- Refactored the embedding upload script. Changes to make it faster (got
  annoyed by how slow it was when testing...), incorporate retries, and
  produce better summary logs.
- Upload script, when run with the environment variable
  ENABLED_FEATURES_OVERRIDE_DISABLE_ALL, produces and uploads the
  alternate search index
- Changed all the search calls in frontend/API to check for
  `isFeatureEnabled('search:fullIndex')` to determine whether to search
  the full or alternate index

* ci: produce nimbus search indexes on merge

* fix: turn full search index on
2025-09-16 12:37:53 -04:00
Charis e46ab9c1a2 refactor: reading markdown docs files (#37774)
* refactor: reading markdown docs files

Refactor how Markdown docs files are read:
- Reuses the same logic across search index generation & page generation
- Improves the indexed content for search:
  - Stops removing MDX components, which often contain useful
    information like Admonitions
  - Denormalizes Partials and CodeSamples for more complete content

This is a prerequisite step for implementing the "Copy docs as Markdown"
functionality.

Only touches regular guides for now, not federated ones.

* fix: tailwind build error (#37728)

We changed to default to ESM imports a while ago, which means local
builds are now breaking because the Tailwind uses a require. Changed to
CJS for Tailwind config file. (I have no idea how this has been working
on Vercel all this time.)

* style: prettier
2025-08-13 11:37:14 -04:00
Charis cf3ecc93eb chore(docs): turn on strictNullChecks (#36180)
strictNullChecks was off for docs, which lets errors slip through and
leads to incorrect required/optional typing on Zod-inferred types. This
PR enables strictNullChecks and fixes all the existing violations.
2025-06-04 17:05:37 -04:00
Charis f58eead769 chore(docs): clean up environment variables (#36036)
Our environment variables are a bit of a mess, so cleaning them up:

- We have duplicate environment variables that resolve to the same thing
but just have different names, deduplicating all of these
- We have a .env.development (for publicly safe variables) and a
.env.example, we
really only need one
- Privately, we have a .env (for running scripts) and a .env.local (for
Next.js). Changing the dotenv source for scripts, so again we only need
one
2025-05-29 16:35:26 -04:00
Charis 33b9e1ed29 chore(docs): convert all scripts to esm (#35996)
Scripts currently use CJS, which is causing a bit of a mess when trying
to use shared utilities from the app. Converting everything to ESM so
there are fewer conflicts when adding new scripts going forward.
2025-05-29 15:44:55 -04:00
Charis 46a0e80a10 feat: llms.txt (#33780)
* feat: llms.txt

* feat: split llms.txt into multiple files

We have too many docs, so the concatenated text file uses an unreasonable amount of tokens. Chunk it up a little so it's more usable.
2025-02-24 15:18:51 -05:00
Ivan Vasilov a63731bbf8 chore: Bump turbo to v2 (#27182)
* Bump the version of turbo to 2.0.3.

* Fix the breaking changes in turbo config.

* Make the npm version more loose.

* Fix the build command for the database-design app.

* Try adding some env vars to the turbo for www.

* Add more missing env vars.

* Bump the turbo version to 2.0.4.

* Remove SUPABASE_SERVICE_ROLE_KEY from docs#build since it's used by other scripts, not by build.
2024-06-18 12:32:36 +02:00
Charis 0c1ab7e2e5 refactor: factor out markdown processing utils (#26729) 2024-06-04 14:00:24 -04:00
Terry Sutton a5d00f9923 Chore/rename open ai key name (#21856)
* Rename OPENAI_KEY to OPENAI_API_KEY

* Force a redeploy
2024-04-25 09:38:56 -02:30
CharisandGreg Richardson d6234f823a fix: include integrations in our search indexes (#20709)
Co-authored-by: Greg Richardson <greg.nmr@gmail.com>
2024-01-26 15:20:54 -05:00
Charis 6c4311f723 fix: improve docs search ux and result rankings (#19450)
Improve the way docs are indexed and FTS results are ranked, so results are more relevant.

Also improve debouncing and searching UX so it feels a bit faster and you can scan the results more easily.
2023-12-06 12:27:33 -05:00
Ivan Vasilov e32b146bc1 chore: Bump the OpenAI lib version to v4 in the docs app (#19253)
Bump the OpenAI lib version to v4 in the docs app.
2023-11-27 21:23:05 +01:00
Kevin Grüneberg fb48035ab6 chore: use node parseArgs instead of minimist (#18683) 2023-11-03 17:02:34 +01:00
Greg Richardson 42d88eef6a fix(doc-embeddings): minimist import 2023-09-19 10:39:24 -06:00
Kevin Grüneberg 0f576e93e2 chore: remove unused docs dependencies 2023-09-14 19:40:50 +02:00
Alaister Young 788e899e6a Merge branch 'master' into chore/upgrade-to-node-18 2023-06-05 15:33:02 +10:00
sd0 b752c82bf5 feat(docs): add yargs 2023-05-30 08:20:34 +08:00
Alaister Young 0ecf4b65f1 fixes studio and www builds 2023-05-29 14:42:50 +10:00
Greg Richardson 7fd4180325 fix(embeddings): github discussions ci 2023-04-25 11:38:02 -06:00
Greg Richardson ef2753cab2 feat(embeddings): github app auth 2023-04-24 17:49:00 -06:00
Greg Richardson 8455437243 Merge branch 'feat/zero-downtime-embeddings-refresh' into feat/ingest-github-discussions-for-search 2023-04-24 14:46:34 -06:00
Greg Richardson 19584f8647 chore(embeddings): add log when removing old pages 2023-04-24 14:37:22 -06:00
Greg Richardson 0f064cb584 fix(embeddings): missing fields when updating/upserting pages 2023-04-21 15:38:45 -06:00
Greg Richardson 60953ee066 feat(embeddings): zero downtime refresh 2023-04-21 14:53:13 -06:00
Greg Richardson 6c373f8313 fix(embeddings): missing github access token env var requirement 2023-04-21 13:13:35 -06:00
Greg Richardson 1ff754b879 chore: remove algolia build-search script 2023-04-20 17:49:20 -06:00