feat(studio): documentation for retiring persisted operations#255
Open
feat(studio): documentation for retiring persisted operations#255
Conversation
WalkthroughUpdated persisted operations doc: changed command reference to Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ 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. Comment |
5 tasks
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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."
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
🧹 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). + + + 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.
comatory
requested review from
Aenimus,
Noroth and
StarpTech
and removed request for
a team
There was a problem hiding this comment.
🧹 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documents new feature for retiring persisted operations:
wundergraph/cosmo#2553
Summary by CodeRabbit
Checklist
mintlify dev