Skip to content

feat(studio): documentation for retiring persisted operations#255

Merged
comatory merged 4 commits intomainfrom
ondrej/eng-8830-controlplane-cli-delete-persistent-operation-docs
Mar 2, 2026
Merged

feat(studio): documentation for retiring persisted operations#255
comatory merged 4 commits intomainfrom
ondrej/eng-8830-controlplane-cli-delete-persistent-operation-docs

Conversation

@comatory
Copy link
Copy Markdown
Contributor

@comatory comatory commented Feb 27, 2026

Description

Documents new feature for retiring persisted operations:
wundergraph/cosmo#2553

Summary by CodeRabbit

  • Documentation
    • Updated persisted-operations CLI reference to use the correct plural command and fixed inline link formatting.
    • Added a "Deleting persisted operations in Studio" section with UI steps, required roles, single-deletion flow, and confirmation/traffic warning.
    • Clarified wording ("step-by-step guide") and performed minor formatting cleanups.

Checklist

  • I have validated my changes locally using mintlify dev
  • I have validated my changes are working as expected by looking at the preview deployment
  • All links in my documentation work correctly
  • All images render properly
  • Code examples are tested and formatted correctly
  • If I added new pages, they are included in the navigation (docs.json)

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Feb 27, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ac0aa7d and ae0290a.

📒 Files selected for processing (1)
  • docs/router/persisted-queries/persisted-operations.mdx

Walkthrough

Updated persisted operations doc: changed command reference to wgc operations push, fixed the Push link to see [Push](/cli/operations/push), added a "Deleting persisted operations in Studio" section with UI steps, role/permission notes, and a deletion confirmation/traffic warning; normalized hyphenation and removed a trailing newline.

Changes

Cohort / File(s) Summary
Documentation - Persisted Operations Guide
docs/router/persisted-queries/persisted-operations.mdx
Replaced wgc operation push with wgc operations push; corrected Push link to see [Push](/cli/operations/push); added "Deleting persisted operations in Studio" section (UI steps, role/permission notes, confirmation/traffic warning); normalized "step-by-step" hyphenation; removed trailing newline.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title mentions 'retiring persisted operations' but the actual changes focus on adding documentation for deleting persisted operations in Studio, with corrections to command references and link formatting. Clarify whether the primary focus is on deletion/retirement operations or command reference corrections, and ensure the title accurately reflects the main content changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/router/persisted-queries/persisted-operations.mdx`:
- Line 53: Update the phrase "step by step guide" to the hyphenated compound
adjective form "step-by-step guide" in the sentence referencing the Using
Persisted Operation with Federated GraphQL tutorial so the text reads:
"Additionally, check the [Using Persisted Operation with Federated
GraphQL](/tutorial/using-persisted-operations) tutorial for a step-by-step
guide."

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dec29c6 and d3431c6.

📒 Files selected for processing (1)
  • docs/router/persisted-queries/persisted-operations.mdx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/router/persisted-queries/persisted-operations.mdx (1)

55-70: New section is well-structured and informative.

The "Retiring persisted operations in Studio" section clearly documents:

  • Step-by-step UI navigation
  • Role-based permission requirements
  • Important warnings about traffic detection

One minor suggestion: Per coding guidelines, consider adding a screenshot showing the retire button location (archive icon) to make step 4 clearer for users unfamiliar with the UI.

📸 Optional: Add screenshot for UI clarity
 4. Expand the operation and click the retire button (archive icon).
+
+![Retire operation button](/images/router/persisted-queries/retire-operation-button.png)
+
 5. Confirm in the retire dialog.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/router/persisted-queries/persisted-operations.mdx` around lines 55 - 70,
Add a screenshot showing the retire button (archive icon) to the "Retiring
persisted operations in Studio" section to clarify step 4; capture the client
View Operations UI with the archive icon visible, add the image asset to the
docs assets and insert an image reference near the step (adjacent to the line
"Expand the operation and click the retire button (archive icon)"), include a
short caption like "Retire (archive) button in Studio" and ensure alt text for
accessibility.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/router/persisted-queries/persisted-operations.mdx`:
- Around line 55-70: Add a screenshot showing the retire button (archive icon)
to the "Retiring persisted operations in Studio" section to clarify step 4;
capture the client View Operations UI with the archive icon visible, add the
image asset to the docs assets and insert an image reference near the step
(adjacent to the line "Expand the operation and click the retire button (archive
icon)"), include a short caption like "Retire (archive) button in Studio" and
ensure alt text for accessibility.

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d3431c6 and 1332778.

📒 Files selected for processing (1)
  • docs/router/persisted-queries/persisted-operations.mdx

@comatory comatory marked this pull request as ready for review February 27, 2026 09:28
@comatory comatory requested review from a team as code owners February 27, 2026 09:28
@comatory comatory requested review from Aenimus, Noroth and StarpTech and removed request for a team February 27, 2026 09:28
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/router/persisted-queries/persisted-operations.mdx (1)

55-70: Consider using code formatting for role identifiers.

The new section is well-structured with clear numbered steps and appropriate use of the <Note> component for the traffic warning. However, the role names on line 65 would benefit from code formatting to clearly distinguish them as system identifiers.

📝 Suggested formatting improvement
-Only organization users with `organization-admin` or `organization-developer` roles can delete operations.
+Only organization users with the `organization-admin` or `organization-developer` role can delete operations.

Actually, reviewing again - the roles already have backticks in the source. The change looks good as-is.

LGTM!

The new "Deleting persisted operations in Studio" section is well-documented with:

  • Clear step-by-step UI instructions
  • Role-based access requirements with proper code formatting
  • Appropriate warning about traffic detection before deletion
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/router/persisted-queries/persisted-operations.mdx` around lines 55 - 70,
The role identifiers in the "Deleting persisted operations in Studio" section
should be presented as code literals; verify that `organization-admin` and
`organization-developer` are wrapped in backticks in the "Only organization
users..." sentence (or add backticks if missing) and otherwise leave the section
as-is since the reviewer confirmed formatting is already correct.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/router/persisted-queries/persisted-operations.mdx`:
- Around line 55-70: The role identifiers in the "Deleting persisted operations
in Studio" section should be presented as code literals; verify that
`organization-admin` and `organization-developer` are wrapped in backticks in
the "Only organization users..." sentence (or add backticks if missing) and
otherwise leave the section as-is since the reviewer confirmed formatting is
already correct.

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1332778 and ac0aa7d.

📒 Files selected for processing (1)
  • docs/router/persisted-queries/persisted-operations.mdx

Copy link
Copy Markdown
Contributor

@StarpTech StarpTech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@comatory comatory merged commit 04dae06 into main Mar 2, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants