mirror of
https://github.com/supabase/supabase.git
synced 2026-09-06 18:11:51 +08:00
f77e8e75b6
## 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? Docs update. * https://docs-git-docs-wire-server-v1-reference-supabase.vercel.app/docs/reference/server/introduction * <img width="417" height="628" alt="Screenshot 2026-07-06 at 6 13 33 PM" src="https://github.com/user-attachments/assets/9fc27b04-038b-4434-8855-94051f898b5d" /> ## What is the current behavior? `@supabase/server` has no reference documentation page in the Supabase docs. The library publishes a TypeDoc spec to GitHub Pages but the docs pipeline was not wired up to consume it. ## What is the new behavior? - Adds `spec/reference/server/v1/` with a `config.json` (category order: Middleware, Primitives, Adapters, Errors, Types) and `partials/` for the introduction and installing pages. - Adds a `download.server.v1` Makefile target that fetches `https://supabase.github.io/server/spec.json` into `spec/reference/server/v1/server.json`, and wires it into the top-level `download` target so it runs with the rest. - Registers `server-v1` in `SUPPORTS_NEW_REFERENCE_PROCESS` so the build pipeline picks up the new spec directory and generates `content/reference/server/v1/` at build time. - Seeds the generated `docs/ref/server/` partials (introduction and installing) that the reference router serves. ## Additional context The TypeDoc spec is produced by `@supabase/server`'s `docs.yml` workflow on every push to `main`, so `make download.server.v1` will always pull the latest published API surface. The companion PR in the server repo ([supabase/server#95](https://github.com/supabase/server/pull/95)) adds the `@category` tags that the pipeline requires for symbols to appear in navigation. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added a new **Server SDK** item under **Reference**, linking to `/reference/server` and marked with a **New** badge. * Published **Server Reference v1** documentation for `@supabase/server`, including **Introduction** and **Installing** pages. * **Chores / Improvements** * Enhanced the reference documentation generation to include Server v1 content. * Improved reference detail handling (including clearer TypeDoc output such as **Deprecated** notes). <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
20 lines
908 B
TypeScript
20 lines
908 B
TypeScript
/**
|
|
* Standalone constants for the reference pipeline.
|
|
*
|
|
* This file intentionally has no runtime dependencies — and in particular,
|
|
* it must NOT import anything that transitively pulls in `next/navigation`,
|
|
* `next/headers`, or any other client-only module. It is loaded by both UI
|
|
* code (e.g. `Reference.generated.singleton.ts` used in app routes) and
|
|
* server-only scripts run with `tsx --conditions=react-server`
|
|
* (e.g. `scripts/llms.ts`), where the server React build lacks
|
|
* `createContext` and Next.js client modules crash on import.
|
|
*/
|
|
|
|
/**
|
|
* SDK/version pairs (`${sdkId}-${version}`) that opt into the new reference
|
|
* content pipeline produced by `scripts/build-reference-content.ts`. Anything
|
|
* not listed here keeps reading from the legacy `features/docs/generated/`
|
|
* outputs.
|
|
*/
|
|
export const SUPPORTS_NEW_REFERENCE_PROCESS = new Set(['javascript-v2', 'dart-v2', 'server-v1'])
|