mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
Jeremias Menichelli
7f1df457f8
## Problem For the new search, we will scan all files present within the public/markdown directory, extract text nodes and upsert a new Supabase table in a new project to do FTS type search. ## Solution In this PR: - A new script directory is created with files to solve all the steps described above. - Unit tests added for the fundamental bits of the script. - A new workflow file is added so the action runs after push every time content is altered, added or removed. <!-- ## Preview links If relevant, include links to changed pages for easy review access. Copy the preview base URL from the Vercel bot comment on this PR. Use the following table as an example template. | Site | Live | Preview | Search for | | -------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ----------------------------- | | WWW | [/blog/your-post](https://supabase.com/blog/your-post) | [/blog/your-post](https://zone-www-dot-com-git-branch-name-supabase.vercel.app/blog/your-post) | unique phrase from the change | | Docs | [/docs/guides/your-page](https://supabase.com/docs/guides/your-page) | [/docs/guides/your-page](https://docs-git-branch-name-supabase.vercel.app/docs/guides/your-page) | unique phrase from the change | | Studio | [/dashboard](https://supabase.com/dashboard) | [/dashboard](https://studio-git-branch-name-supabase.vercel.app/dashboard) | unique phrase from the change | | Design system | [/design-system](https://supabase.com/design-system) | [/design-system](https://design-system-git-branch-name-supabase.vercel.app/design-system) | unique phrase from the change | | UI library | [/library](https://supabase.com/library) | [/library](https://ui-library-git-branch-name-supabase.vercel.app/library) | unique phrase from the change | | Knowledge base | [/kb/guides/your-page](https://supabase.com/kb/guides/your-page) | [/kb/guides/your-page](https://kb-git-branch-name-supabase.vercel.app/kb/guides/your-page) | unique phrase from the change | --> <!-- ## Additional context Optionally add any other context or screenshots. --> ## Review instructions Sadly, testing this work is quite complex, but in case someone wants to: 1. Create a new Supabase project ton your personal space 1. Copy the id of the project and a secret key and add it to the new Search V2 environment variables as shown in the example file 1. Copy the content of the newly added `setup.sql` and run it on the SQL editor of your project. 1. Fetch this branch and on the search directory, run `search-v2:ingest` 1. Your project's table should have rows corresponding to the content from docs ## Checklist Check all before review: - [x] I have read [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) - [x] If I wrote a new docs topic or edited an existing topic, I used the `/write-the-docs` or `/edit-the-docs` skill, which references [WORD_LIST](https://github.com/supabase/supabase/blob/master/apps/docs/WORD_LIST.md) and the docs [CONTRIBUTING](https://github.com/supabase/supabase/blob/master/apps/docs/CONTRIBUTING.md) guide <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Documentation pages are now indexed for full-text search at the page and section level. - Search results can show the most relevant section from each page, with its title, heading, excerpt, and relevance score. - Search content is automatically refreshed when published Markdown documentation changes. - **Tests** - Added coverage for Markdown parsing, page structure, routing, and search-content generation. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
192 lines
7.9 KiB
JSON
192 lines
7.9 KiB
JSON
{
|
|
"name": "docs",
|
|
"version": "0.0.0",
|
|
"private": true,
|
|
"type": "module",
|
|
"scripts": {
|
|
"build": "next build",
|
|
"build:analyze": "ANALYZE=true next build",
|
|
"build:guides-markdown": "tsx ./internals/generate-guides-markdown.ts",
|
|
"build:federated-content": "tsx --conditions=react-server ./scripts/federated-content/fetch-federated-content.ts",
|
|
"prebuild:reference-markdown": "pnpm run codegen:references",
|
|
"build:reference-markdown": "tsx ./internals/generate-reference-markdown.ts",
|
|
"build:markdown": "pnpm build:guides-markdown && pnpm build:reference-markdown",
|
|
"build:gz-archive": "tsx ./internals/generate-gz-archive.ts",
|
|
"build:sitemap": "tsx ./internals/generate-sitemap.ts",
|
|
"clean": "rimraf .next .turbo features/docs/generated examples __generated__ tsconfig.tsbuildinfo",
|
|
"codegen:examples": "shx cp -r ../../examples ./examples",
|
|
"codegen:graphql": "tsx --conditions=react-server ./scripts/graphqlSchema.ts && graphql-codegen --config codegen.ts",
|
|
"codegen:references:new:ensure": "(test -f spec/reference/javascript/v2/supabase.json || (cd spec && make download.tsdoc.v2)) && (test -f spec/reference/server/v1/server.json || (cd spec && make download.server.v1)) && (test -f spec/reference/middleware/v1/middleware.json || (cd spec && make download.middleware.v1))",
|
|
"codegen:references:dart": "tsx scripts/generate-dart-reference.ts",
|
|
"precodegen:references:new": "pnpm run codegen:references:new:ensure && pnpm run codegen:references:dart",
|
|
"codegen:references:new": "pnpm run codegen:references:new:ensure && tsx scripts/build-reference-content.ts",
|
|
"codegen:references:legacy": "tsx features/docs/Reference.generated.script.ts",
|
|
"codegen:references": "pnpm codegen:references:legacy && pnpm codegen:references:new",
|
|
"dev": "run-p --race dev:next dev:watch:troubleshooting",
|
|
"dev:next": "next dev --port 3001",
|
|
"dev:secrets:pull": "AWS_PROFILE=supa-dev node ../../scripts/getSecrets.js -n local/docs",
|
|
"dev:watch:troubleshooting": "node ./scripts/troubleshooting/watch.mjs",
|
|
"embeddings": "tsx --conditions=react-server scripts/search/generate-embeddings.ts",
|
|
"embeddings:nimbus": "ENABLED_FEATURES_OVERRIDE_DISABLE_ALL=true pnpm run embeddings",
|
|
"embeddings:refresh": "pnpm run embeddings --refresh",
|
|
"embeddings:nimbus:refresh": "ENABLED_FEATURES_OVERRIDE_DISABLE_ALL=true pnpm run embeddings:refresh",
|
|
"last-changed": "tsx scripts/last-changed.ts",
|
|
"last-changed:reset": "pnpm run last-changed -- --reset",
|
|
"lint": "eslint .",
|
|
"postbuild": "pnpm run build:sitemap && ./../../scripts/upload-static-assets.sh",
|
|
"prebuild": "pnpm run codegen:graphql && pnpm run codegen:references && pnpm run codegen:examples && pnpm build:federated-content && pnpm run build:markdown && pnpm run build:gz-archive",
|
|
"predev": "pnpm run codegen:graphql && pnpm run codegen:references && pnpm run codegen:examples",
|
|
"preembeddings": "pnpm run codegen:references",
|
|
"preinstall": "npx only-allow pnpm",
|
|
"presearch-v2:ingest": "pnpm run build:guides-markdown",
|
|
"presync": "pnpm run codegen:graphql",
|
|
"pretest": "pnpm run codegen:examples",
|
|
"pretypecheck": "pnpm run codegen:graphql && next typegen",
|
|
"search-v2:ingest": "tsx scripts/search_v2/ingest.ts",
|
|
"start": "next start",
|
|
"sync": "tsx --conditions=react-server ./resources/rootSync.ts",
|
|
"test": "pnpm supabase start && pnpm run test:local && pnpm supabase stop",
|
|
"test:local": "vitest --exclude \"**/*.smoke.test.ts\"",
|
|
"test:local:unwatch": "vitest --exclude \"**/*.smoke.test.ts\" --run",
|
|
"test:smoke": "pnpm run codegen:references && vitest -t \"prod smoke test\"",
|
|
"troubleshooting:sync": "node features/docs/Troubleshooting.script.mjs",
|
|
"typecheck": "tsc --noEmit"
|
|
},
|
|
"dependencies": {
|
|
"@har-sdk/openapi-sampler": "^2.2.0",
|
|
"@hookform/resolvers": "^3.1.1",
|
|
"@mdx-js/loader": "^3.0.0",
|
|
"@mdx-js/react": "^3.0.0",
|
|
"@next/bundle-analyzer": "15.3.1",
|
|
"@next/mdx": "15.3.1",
|
|
"@octokit/auth-app": "^7.0.0",
|
|
"@octokit/core": "^7.0.6",
|
|
"@octokit/graphql": "^8.0.0",
|
|
"@octokit/plugin-paginate-graphql": "^4.0.0",
|
|
"@octokit/plugin-retry": "^8.1.0",
|
|
"@sentry/nextjs": "catalog:",
|
|
"@supabase/supabase-js": "catalog:",
|
|
"@tanstack/react-query": "~5.83.0",
|
|
"acorn": "^8.11.3",
|
|
"acorn-typescript": "^1.4.13",
|
|
"ai-commands": "workspace:*",
|
|
"beautiful-mermaid": "^1.1.3",
|
|
"class-variance-authority": "^0.7.1",
|
|
"common": "workspace:*",
|
|
"common-tags": "^1.8.2",
|
|
"config": "workspace:*",
|
|
"dev-tools": "workspace:*",
|
|
"eslint-config-supabase": "workspace:*",
|
|
"framer-motion": "^11.18.2",
|
|
"github-slugger": "^2.0.0",
|
|
"graphql": "^16.10.0",
|
|
"graphql-validation-complexity": "^0.4.2",
|
|
"gray-matter": "^4.0.3",
|
|
"hast-util-has-property": "^2.0.1",
|
|
"hast-util-to-html": "^9.0.5",
|
|
"icons": "workspace:*",
|
|
"isbot": "^5.1.2",
|
|
"js-yaml": "^3.14.2",
|
|
"jsrsasign": "^11.0.0",
|
|
"katex": "^0.16.21",
|
|
"libpg-query": "15.2.0",
|
|
"lodash-es": "catalog:",
|
|
"lucide-react": "*",
|
|
"mdast": "^3.0.0",
|
|
"mdast-util-from-markdown": "^1.2.0",
|
|
"mdast-util-gfm": "^2.0.2",
|
|
"mdast-util-mdx": "^2.0.0",
|
|
"mdast-util-mdx-jsx": "^2.0.0",
|
|
"mdast-util-to-hast": "^12.3.0",
|
|
"mdast-util-to-markdown": "^1.5.0",
|
|
"mdast-util-to-string": "^3.1.1",
|
|
"micromark-extension-gfm": "^2.0.3",
|
|
"micromark-extension-mdxjs": "^1.0.0",
|
|
"next": "^15.5.24",
|
|
"next-mdx-remote-client": "^1.1.7",
|
|
"next-plugin-yaml": "^1.0.1",
|
|
"next-themes": "catalog:",
|
|
"nuqs": "^1.19.1",
|
|
"openai": "^4.75.1",
|
|
"openapi-fetch": "0.12.4",
|
|
"radix-ui": "catalog:",
|
|
"react": "catalog:",
|
|
"react-copy-to-clipboard": "^5.1.0",
|
|
"react-dom": "catalog:",
|
|
"react-error-boundary": "^4.0.12",
|
|
"react-hook-form": "^7.71.2",
|
|
"react-intersection-observer": "^9.5.3",
|
|
"react-markdown": "^10.1.0",
|
|
"react-use": "^17.5.0",
|
|
"rehype-katex": "^7.0.0",
|
|
"rehype-slug": "^5.1.0",
|
|
"remark": "^14.0.2",
|
|
"remark-emoji": "^3.1.2",
|
|
"remark-gfm": "^4.0.0",
|
|
"remark-math": "^6.0.0",
|
|
"server-only": "^0.0.1",
|
|
"shared-data": "workspace:*",
|
|
"ui": "workspace:*",
|
|
"ui-patterns": "workspace:*",
|
|
"unist-builder": "^3.0.1",
|
|
"unist-util-filter": "^4.0.1",
|
|
"unist-util-visit": "^4.1.2",
|
|
"uuid": "^14.0.0",
|
|
"valtio": "catalog:",
|
|
"yaml": "^2.8.1",
|
|
"zod": "catalog:"
|
|
},
|
|
"devDependencies": {
|
|
"@babel/core": "*",
|
|
"@graphiql/toolkit": "^0.9.1",
|
|
"@graphql-codegen/cli": "5.0.5",
|
|
"@graphql-codegen/typescript": "4.1.6",
|
|
"@graphql-codegen/typescript-resolvers": "4.5.0",
|
|
"@redocly/cli": "^2.26.0",
|
|
"@testing-library/react": "^16.3.3",
|
|
"@types/common-tags": "^1.8.4",
|
|
"@types/estree": "1.0.5",
|
|
"@types/graphql-validation-complexity": "^0.4.4",
|
|
"@types/hast": "^2.3.4",
|
|
"@types/jsrsasign": "^10.5.12",
|
|
"@types/lodash-es": "^4.17.12",
|
|
"@types/mdast": "^3.0.0",
|
|
"@types/node": "catalog:",
|
|
"@types/react": "catalog:",
|
|
"@types/react-copy-to-clipboard": "^5.0.4",
|
|
"@types/react-dom": "catalog:",
|
|
"@types/unist": "^2.0.6",
|
|
"@typescript/native": "catalog:",
|
|
"amaro": "^1.1.5",
|
|
"api-types": "workspace:*",
|
|
"cheerio": "^1.0.0-rc.12",
|
|
"chokidar": "^4.0.3",
|
|
"config": "workspace:*",
|
|
"dotenv": "^16.0.3",
|
|
"ejs": "^3.1.10",
|
|
"fast-glob": "^3.3.3",
|
|
"globby": "^13.2.2",
|
|
"graphiql": "^4.0.2",
|
|
"npm-run-all": "^4.1.5",
|
|
"openapi-types": "^12.1.3",
|
|
"postcss": "catalog:",
|
|
"remark-frontmatter": "^5.0.0",
|
|
"remark-parse": "^11.0.0",
|
|
"shiki": "^3.2.1",
|
|
"shx": "^0.4.0",
|
|
"simple-git": "^3.24.0",
|
|
"slugify": "^1.6.6",
|
|
"smol-toml": "^1.3.1",
|
|
"tailwindcss": "catalog:",
|
|
"tar": "^7.5.21",
|
|
"tsconfig": "workspace:*",
|
|
"tsx": "catalog:",
|
|
"twoslash": "^0.3.1",
|
|
"typescript": "catalog:",
|
|
"unified": "^11.0.5",
|
|
"unist-util-visit-parents": "5.1.3",
|
|
"vite": "catalog:",
|
|
"vitest": "catalog:"
|
|
}
|
|
}
|