docs: remove em-dashes from documentation pages (UER-50) - #3271
docs: remove em-dashes from documentation pages (UER-50)#3271nachocossio wants to merge 1 commit into
Conversation
Rewrite 643 em-dashes across 49 MDX pages and openapi.json with contextual punctuation. Keep 4 that quote literal product UI strings. Fix a stale anchor in installation.mdx.
|
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:XL
✅ 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. |
Internal previewPreview URL: https://mcp-inspector-pr-3271.up.railway.app |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (50)
WalkthroughThis pull request refreshes documentation across CLI workflows, Inspector features, SDK concepts, API references, troubleshooting pages, and changelog entries. Updates primarily reformat lists, normalize punctuation, clarify command behavior and authentication flows, expand credential and host-configuration guidance, document protocol and evaluation behavior, and revise JSON-RPC error-code presentation. No exported declarations or functional implementation code are changed. 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 |
2 participants
Summary
Part 1 of UER-50 (Documentation Cleanup). Rewrites 643 em-dashes across 49 MDX pages and
docs/reference/openapi.jsonwith contextual punctuation (colons, commas, parentheses, or sentence splits), chosen case by case rather than mechanically replaced.Intentionally kept (4)
These quote literal strings the product renders; changing the doc would misquote the UI. Removing them requires changing product strings (separate task):
docs/inspector/evals.mdx— "Synced from CI — the next CI report may overwrite manual edits." (test-template-editor.tsx)docs/inspector/host-compat.mdx— "Best-effort preset — unverified" (HostCompatContent.tsx)docs/inspector/projects.mdx— "Hidden — Reveal to view" (EnvVarsSection.tsx)docs/inspector/guided-oauth.mdx— "Saved — enter a new value to replace" (AuthenticationSection.tsx)Notes for review
✗in the installation capability matrix,N/Ain the protocol-versions host-default row,(none)in eval-reporting's predicate table.installation.mdx→api-keys#playground-byok-not-an-mcpjam-key.openapi.jsonedits are description-string-only; the route-parity drift test (openapi-drift.test.ts) passes 5/5.Verification
docs/**/*.mdx+openapi.jsonoutside the 4 quoted UI strings above.Summary by cubic
Replaced typographic em-dashes across documentation with clearer punctuation for consistency and readability, including
docs/reference/openapi.json. Part 1 of UER-50; content only, no behavior changes.Refactors
openapi.jsonusing colons, commas, parentheses, or sentence splits as appropriate.✗,N/A,(none)).openapi.jsonedits are description-only; route-parity drift test still passes.Bug Fixes
installation.mdx(now points toapi-keys#playground-byok-not-an-mcpjam-key).Written for commit 530f138. Summary will update on new commits.