AI & Agent Dev Bug Sandbox logo
AI & Agent Dev Bug Sandbox
Back to Radar

Docs Contributor Guide Points JavaScript V2 Authors At Retired YAML Pipeline

The JavaScript v2 reference contributor instructions in apps/docs/CONTRIBUTING.md still direct authors to edit apps/docs/spec/supabase_js_v2.yml and describe legacy $ref extraction, even though JavaScript v2 now uses the TypeDoc pipeline and is excluded from the legacy generator. This misleads contributors and hides the active authoring workflow.

mediumConfidence 95%Supabase-DocsAffected Vmaster@4ab54b935919ba3f4bb92f436ae4e757108e4f8a

Origin Analysis

After PR #46502 migrated JavaScript v2 to the TypeDoc pipeline, the contributor guide was not updated to reflect the new workflow. PR #50743 later shortened the guide but retained the outdated reference-structure section that uses the retired YAML spec as the primary JavaScript example.
1. Check out supabase/supabase at revision 4ab54b935919ba3f4bb92f436ae4e757108e4f8a. 2. Open apps/docs/CONTRIBUTING.md and read lines 100-128. The 'Specific spec file' section links to apps/docs/spec/supabase_js_v2.yml and describes $ref extraction and transformation. 3. Open apps/docs/features/docs/Reference.constants.ts lines 13-24 and Reference.generated.script.ts lines 165-175. JavaScript v2 is in the new-pipeline set and excluded from the legacy generator. 4. Open apps/docs/spec/reference/README.md and Makefile lines 46-70. The active JavaScript v2 pipeline uses TypeDoc JSON, hand-authored config.json/partials, and scripts/build-reference-content.ts. 5. Observe that the contributor guide does not point to this pipeline and thus instructs editing a file the active generator skips.

Fixing Code Block

Replace the content in `apps/docs/CONTRIBUTING.md` from line 100 through line 128 with the following markdown: ```markdown ## Reference structure The JavaScript v2 client (`javascript-v2`) no longer uses the legacy YAML spec at `apps/docs/spec/supabase_js_v2.yml`. It now uses the TypeDoc pipeline described in [`apps/docs/spec/reference/README.md`](apps/docs/spec/reference/README.md). ### JavaScript v2 authoring workflow - **Authoring inputs (tracked in the repo):** - SDK source JSDoc/TSDoc comments in the respective packages under `packages/` (for example `packages/supabase-js`, `packages/auth-js`, `packages/postgrest-js`, `packages/realtime-js`, `packages/storage-js`, `packages/functions-js`). - Docs-app configuration and partials under `apps/docs/spec/reference/`. - **Generated/downloaded artifacts (not hand-edited):** - TypeDoc JSON downloaded by the Makefile into `apps/docs/spec/reference/` (or configured output directories). - Rendered reference pages generated by `scripts/build-reference-content.ts`. To contribute JavaScript v2 reference docs: 1. Update the SDK source comments or the docs-app configuration/partials. 2. Run the reference pipeline as documented in [`apps/docs/spec/reference/README.md`](apps/docs/spec/reference/README.md), or invoke the relevant Makefile target to refresh downloaded TypeDoc JSON and generated output. 3. Do not edit `apps/docs/spec/supabase_js_v2.yml` for JavaScript v2; that file is consumed only by the legacy generator for SDKs that still use it. ### Legacy YAML workflow The legacy YAML spec instructions still apply only to SDKs that have not been migrated to the TypeDoc pipeline. Check [`apps/docs/features/docs/Reference.constants.ts`](apps/docs/features/docs/Reference.constants.ts) and the legacy generator exclusions in [`apps/docs/features/docs/Reference.generated.script.ts`](apps/docs/features/docs/Reference.generated.script.ts) before editing a YAML spec. If the library is in the new-pipeline set, follow the TypeDoc workflow above instead. ```
The replacement documentation explicitly marks JavaScript v2 as migrated to the TypeDoc pipeline, lists tracked authoring inputs vs. generated artifacts, links to the relevant pipeline README, and retains legacy YAML instructions only for SDKs that still use that path. This prevents contributors from editing a retired file and directs them to the correct workflow.

Edge Case Audit

Documentation-only change with no runtime impact. Risk is low, but if additional SDKs migrate from legacy YAML to TypeDoc without updating this guide, the mismatch could reappear. Maintainers should update the guide together with migration PRs and verify the pipeline constants. Rollback is safe: revert this documentation change.

Ecosystem Topology