Katerina Skroumpelou
81aefa3c55
## 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? Bug fix. ## What is the current behavior? Running `make` in `apps/docs/spec` (used by the `docs-js-libs-update` workflow) fails with: ``` ERR_PNPM_RECURSIVE_EXEC_FIRST_FAIL Command "redocly" not found make: *** [Makefile:56: dereference.api.v1] Error 254 ``` This regression was introduced in #44428, which removed `@redocly/cli` from `packages/generator/package.json` as an "unused" dependency. It was previously placed there because the Makefile ran `cd packages/generator && pnpm exec redocly` — but that directory had no logical ownership of the dependency. ## What is the new behavior? - `@redocly/cli` is now a devDependency of `apps/docs`, which is the package that owns the spec generation workflow. - The Makefile no longer `cd`s into `packages/generator` for the redocly calls. It runs `pnpm exec redocly` directly from `apps/docs/spec`, where the binary is now available. - The `tsdoc:dereference` targets are unchanged and still `cd` into `packages/generator` to run scripts defined there. ## Additional context The `cd packages/generator` pattern for redocly was introduced in #42987 to fix a peer dependency resolution issue with `npx @redocly/cli`. The fix was correct but placed the dependency in the wrong package. This PR moves it to its logical home. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Chores** * Added documentation processing tool as a development dependency. * Updated documentation generation configuration to optimize command execution paths. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
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.