mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
Alaister YoungandAlaister Young
cb34acd45c
The docs build had a fragile implicit dependency on www's filesystem (`../../../apps/www/public/llms`), flagged by the docs team in #44670. Rather than formalising that dependency with a shared package, this PR eliminates it entirely by making www the sole owner of llms content assembly. **How it works now:** `/llms/[slug]` handles all `/llms/*.txt` requests via a 3-step cascade: 1. Dynamic content — `pricing.txt` generated at request time from `shared-data` imports 2. Local file — product overviews read from `data/llms/` 3. Docs proxy — reference docs (guides, js, dart, etc.) fetched from the docs app No hardcoded slug lists, so adding new content just works. **What changed:** - `apps/docs/scripts/llms.ts` trimmed to only generate per-source reference files — www now owns `llms.txt`, `llms-full.txt`, and product overviews - Removed `generateLlmsPricing.mjs` build script — pricing generated dynamically from `shared-data` - Removed llms rewrites from `rewrites.js` — routes handle everything with consistent `Cache-Control: public, s-maxage=3600, stale-while-revalidate=86400` - Product overview `.txt` files moved from `public/llms/` → `data/llms/` so all requests go through routes for consistent caching **Docs team concerns from GROWTH-773:** | Concern | Resolution | |---------|-----------| | Docs build depends on www files at a fragile relative path | Path removed — docs no longer reads from www | | www restructuring breaks docs with no obvious connection | Eliminated — no cross-app filesystem dependency | | No build order enforcement between www and docs | Not needed — docs doesn't depend on www's build output | ## To test - `curl <preview>/llms.txt` — markdown index with doc + product overview links - `curl <preview>/llms-full.txt` — combined product overviews + docs content - `curl <preview>/llms/pricing.txt` — dynamically generated pricing tables - `curl <preview>/llms/auth.txt` — product overview from local file - `curl <preview>/llms/guides.txt` — proxied from docs app - `curl <preview>/llms/nonexistent.txt` — 404 - Verify `Cache-Control` header on all responses --------- Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
Reference Docs
Supabase Reference Docs
Maintainers
If you are a maintainer of any tools in the Supabase ecosystem, you can use this site to provide documentation for the tools & libraries that you maintain.
Versioning
All tools have versioned docs, which are kept in separate folders. For example, the CLI has the following folders and files:
cli: the "next" release.cli_spec: contains the DocSpec for the "next" release (see below).cli_versioned_docs: a version of the documentation for every release (including the most current version).cli_versioned_sidebars: a version of the sidebar for every release (including the most current version).
When you release a new version of a tool, you should also release a new version of the docs. You can do this via the command line. For example, if you just released the CLI version 1.0.1:
npm run cli:version 1.0.1
DocSpec
We use documentation specifications which can be used to generate human-readable docs.
- OpenAPI: for documenting API endpoints.
- SDKSpec (custom to Supabase): for SDKs and client libraries.
- ConfigSpec (custom to Supabase): for configuration options.
- CLISpec (custom to Supabase): for CLI commands and usage.
The benefit of using custom specifications is that we can generate many other types from a strict schema (eg, HTML and manpages). It also means that we can switch to any documentation system we want. On this site we use Next.js, but on Supabase's official website, we use a custom React site and expose only a subset of the available API for each tool.
Contributing
To contribute to docs, see the developers' guide and contributing guide.