Yogeshwaran C
2674009c8a
## What kind of change does this PR introduce? Documentation and copy corrections. ## What is the current behavior? Several docs and one Studio file contain grammar, spelling, and capitalization issues: - JS v1 upgrade guide: "we'll continuing" (should be "we'll continue"), "Some the [PR]" (should be "See the [PR]"), extra space before comma - Realtime docs: "PostgresSQL" (should be "PostgreSQL") in 2 files - Kotlin SDK installing docs: "Websockets" (should be "WebSockets"), "Checkout the" (should be "Check out the") - Broadcast guide: "Websockets" (should be "WebSockets") in code comments (5 occurrences) - Prisma troubleshooting: "Checkout this" (should be "Check out this") - Edge function template: "Websocket Server Example" (should be "WebSocket Server Example") ## What is the new behavior? All grammar, spelling, and capitalization issues are corrected: - **Grammar**: "we'll continue" (verb tense), "See the [PR]" (correct word), removed extra space - **Spelling**: "PostgreSQL" (correct product name) - **Capitalization**: "WebSocket" / "WebSockets" follows the official W3C/IETF naming convention - **Word splitting**: "Check out" as a phrasal verb (two words), vs "checkout" the noun ## Files changed (8) - `apps/docs/docs/ref/javascript/v1/upgrade-guide.mdx` — grammar fixes (3 issues) - `apps/docs/docs/ref/self-hosting-realtime/introduction.mdx` — PostgresSQL -> PostgreSQL - `apps/docs/docs/ref/realtime/realtime.mdx` — PostgresSQL -> PostgreSQL - `apps/docs/docs/ref/kotlin/v2/installing.mdx` — WebSockets + Check out - `apps/docs/docs/ref/kotlin/installing.mdx` — WebSockets + Check out (2 occurrences) - `apps/docs/content/guides/realtime/broadcast.mdx` — Websockets -> WebSockets (5 occurrences) - `apps/docs/content/troubleshooting/prisma-error-management-Cm5P_o.mdx` — Check out - `apps/studio/components/interfaces/Functions/Functions.templates.ts` — WebSocket template name
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.