Add CREATE/DROP SUBSCRIPTION command reference documentation#952
Add CREATE/DROP SUBSCRIPTION command reference documentation#952
Conversation
Co-authored-by: kwannoel <47273164+kwannoel@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds missing SQL command reference pages for managing subscriptions so users can discover CREATE/DROP SUBSCRIPTION syntax and related usage from the SQL docs and the subscription guide.
Changes:
- Added new command reference pages for
CREATE SUBSCRIPTIONandDROP SUBSCRIPTION. - Added navigation entries in
docs.jsonand cross-links from subscription-related pages. - Expanded “Related topics” sections to connect the subscription command docs together.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
sql/commands/sql-create-subscription.mdx |
New reference page documenting CREATE SUBSCRIPTION syntax, parameters, and examples. |
sql/commands/sql-drop-subscription.mdx |
New reference page documenting DROP SUBSCRIPTION syntax, parameters, notes, and examples. |
docs.json |
Adds both new pages to the SQL commands navigation. |
serve/subscription.mdx |
Adds direct links to the CREATE/DROP/ALTER subscription command reference pages. |
sql/commands/sql-alter-subscription.mdx |
Adds “Related topics” cards linking to CREATE/DROP and the subscription guide. |
sql/commands/sql-show-subscriptions.mdx |
Adds a “CREATE SUBSCRIPTION” related-topic card for better discoverability. |
| "sql/commands/sql-create-sink-into", | ||
| "sql/commands/sql-create-sink", | ||
| "sql/commands/sql-create-source", | ||
| "sql/commands/sql-create-subscription", | ||
| "sql/commands/sql-create-table", | ||
| "sql/commands/sql-create-user", |
There was a problem hiding this comment.
The PR description/checklist mentions updating mint.json for new pages, but this repository doesn’t appear to have a mint.json and this PR doesn’t change it. Please either update the correct TOC/navigation file(s) or adjust the PR description/checklist to match what was actually updated (likely docs.json).
| "sql/commands/sql-drop-schema", | ||
| "sql/commands/sql-drop-secret", | ||
| "sql/commands/sql-drop-sink", | ||
| "sql/commands/sql-drop-source", | ||
| "sql/commands/sql-drop-subscription", | ||
| "sql/commands/sql-drop-table", | ||
| "sql/commands/sql-drop-user", | ||
| "sql/commands/sql-drop-view", |
There was a problem hiding this comment.
New command pages are added to docs.json, but sql/commands/overview.mdx currently has cards for ALTER/SHOW subscription commands and still lacks entries for CREATE/DROP SUBSCRIPTION. Consider adding cards there too to keep the SQL commands overview complete and improve discoverability.
Description
Users cannot discover CREATE/DROP SUBSCRIPTION syntax. Missing command reference pages in SQL documentation.
Added:
sql/commands/sql-create-subscription.mdx- Syntax, parameters (retention required), examples for table/MV subscriptionssql/commands/sql-drop-subscription.mdx- Syntax with schema support, notes on cursor cleanupUpdated:
docs.json- Navigation entries for both commands (alphabetical placement)serve/subscription.mdx- Cross-links to all three command referencessql/commands/sql-alter-subscription.mdx- Related topics sectionsql/commands/sql-show-subscriptions.mdx- CREATE SUBSCRIPTION referenceExample:
Related code PR
N/A - Documentation only
Related doc issue
https://github.com/risingwavelabs/risingwave-docs/issues/[issue-number]
Checklist
mint.jsonto include the page in the table of contents.Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.