No AI slop in docs - #3371
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
dosubot
Bot
added
size:M
Internal previewPreview URL will appear in Railway after the deploy finishes. |
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
WalkthroughUpdated documentation wording throughout the changelog, CLI, contributor architecture, onboarding, getting-started, guide, Inspector, and SDK sections. Changes refine descriptions, instructional phrasing, formatting, security language, FAQ answers, OAuth guidance, eval explanations, result-saving behavior, and provider notes without altering exported or public entities. 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 |
![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 current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/inspector/docs-server.mdx`:
- Line 50: Update the “Fits Your Workflow” sentence in the documentation to
replace “tools you already develop in” with the intended wording “tools you
already use” or “tools you already develop with,” preserving the rest of the
description.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 98afc604-8656-47dc-8394-af8aee4945db
📒 Files selected for processing (21)
docs/changelog/overview.mdxdocs/cli/oauth-conformance.mdxdocs/cli/tools-resources-prompts.mdxdocs/contributing/evals-architecture.mdxdocs/contributing/mcp-apps-architecture.mdxdocs/contributing/onboarding.mdxdocs/contributing/openai-sdk-architecture.mdxdocs/contributing/system-architecture.mdxdocs/getting-started.mdxdocs/guides/first-chatgpt-app-react.mdxdocs/guides/first-mcp-app.mdxdocs/index.mdxdocs/inspector/connecting-servers.mdxdocs/inspector/docs-server.mdxdocs/inspector/guided-oauth.mdxdocs/sdk/concepts/connecting-servers.mdxdocs/sdk/concepts/running-evals.mdxdocs/sdk/concepts/saving-results.mdxdocs/sdk/index.mdxdocs/sdk/quickstart.mdxdocs/sdk/reference/llm-providers.mdx
| - **Always Up-to-Date**: Documentation is served in real-time from our latest docs | ||
| - **Contextual Help**: Get answers specific to your current task | ||
| - **Seamless Integration**: Works naturally within your development workflow | ||
| - **Fits Your Workflow**: Works inside the tools you already develop in |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Correct the workflow sentence.
“Tools you already develop in” is awkward and changes the intended meaning. Use “tools you already use” or “tools you already develop with.”
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/inspector/docs-server.mdx` at line 50, Update the “Fits Your Workflow”
sentence in the documentation to replace “tools you already develop in” with the
intended wording “tools you already use” or “tools you already develop with,”
preserving the rest of the description.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 21 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/inspector/docs-server.mdx">
<violation number="1" location="docs/inspector/docs-server.mdx:50">
P3: "Tools you already develop in" reads awkwardly — you develop *with* tools, not *in* them. Consider "tools you already develop with" or "tools you already use."</violation>
</file>
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
| - **Always Up-to-Date**: Documentation is served in real-time from our latest docs | ||
| - **Contextual Help**: Get answers specific to your current task | ||
| - **Seamless Integration**: Works naturally within your development workflow | ||
| - **Fits Your Workflow**: Works inside the tools you already develop in |
There was a problem hiding this comment.
P3: "Tools you already develop in" reads awkwardly — you develop with tools, not in them. Consider "tools you already develop with" or "tools you already use."
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/inspector/docs-server.mdx, line 50:
<comment>"Tools you already develop in" reads awkwardly — you develop *with* tools, not *in* them. Consider "tools you already develop with" or "tools you already use."</comment>
<file context>
@@ -47,7 +47,7 @@ Once connected, you can ask questions like:
- **Always Up-to-Date**: Documentation is served in real-time from our latest docs
- **Contextual Help**: Get answers specific to your current task
-- **Seamless Integration**: Works naturally within your development workflow
+- **Fits Your Workflow**: Works inside the tools you already develop in
- **No Context Switching**: Stay in your editor while accessing documentation
</file context>
| - **Fits Your Workflow**: Works inside the tools you already develop in | |
| - **Fits Your Workflow**: Works inside the tools you already develop with |
GitHub Actions
Error
2 participants
No AI slop in docs
Remove ai slop from docs
Summary by cubic
Tightened wording across docs to remove filler and hype, making instructions clearer and more direct. Updates cover Getting Started, CLI, Guides, Contributing, Inspector, SDK, and Changelog without changing technical meaning or APIs.
Written for commit e8c7848. Summary will update on new commits.