revert: remove docs restructure from MCP auth PR#1672
Conversation
The docs restructure (new MDX pages, overview rewrite, meta.json reorganization, redirect changes) was part of a separate docs task that was accidentally included in the MCP auth flakiness PR (#1608). This reverts only the docs-task-specific changes: - Remove workflow.mdx, task-management.mdx, parallel-agents.mdx - Restore overview.mdx, meta.json, agent-integration.mdx to original - Restore next.config.mjs redirect to /installation - Restore ResourceCard to use target="_blank" for all links MCP-related changes (mcp.mdx, get_workspace_details, etc.) are kept.
📝 WalkthroughWalkthroughThis pull request restructures the documentation by deleting three pages (parallel-agents, task-management, workflow), reorganizing page navigation in meta.json, updating the overview with generalized content, adjusting navigation redirects to point to installation instead of overview, and simplifying a component to unconditionally set external link attributes. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/docs/src/components/ResourceCard/ResourceCard.tsx (1)
29-33:⚠️ Potential issue | 🟡 MinorConsider adding a type constraint to prevent internal hrefs from being passed to
ResourceCard.With
hreftyped only asstring, the component could receive internal paths (e.g.,/installation) that would unexpectedly open in a new tab. The component name andArrowUpRighticon indicate external-only use. Consider using a branded string type (e.g.,ExternalUrl) or runtime validation to enforce this constraint.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@apps/docs/src/components/ResourceCard/ResourceCard.tsx` around lines 29 - 33, The ResourceCard is allowing any string for the href prop which can let internal paths open in a new tab; update the ResourceCard prop type (where href is declared) to require an external-only type (e.g., a branded ExternalUrl type or union like HttpUrl) and add a small runtime guard in the ResourceCard render (check that href starts with "http://" or "https://") to refuse or fallback for non-external values; update any callers to produce the branded ExternalUrl or validate inputs before passing to ResourceCard and ensure the anchor keeps target="_blank" only for validated external hrefs.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@apps/docs/src/components/ResourceCard/ResourceCard.tsx`:
- Around line 29-33: The ResourceCard is allowing any string for the href prop
which can let internal paths open in a new tab; update the ResourceCard prop
type (where href is declared) to require an external-only type (e.g., a branded
ExternalUrl type or union like HttpUrl) and add a small runtime guard in the
ResourceCard render (check that href starts with "http://" or "https://") to
refuse or fallback for non-external values; update any callers to produce the
branded ExternalUrl or validate inputs before passing to ResourceCard and ensure
the anchor keeps target="_blank" only for validated external hrefs.
🧹 Preview Cleanup CompleteThe following preview resources have been cleaned up:
Thank you for your contribution! 🎉 |
Summary
workflow.mdx,task-management.mdx,parallel-agents.mdxoverview.mdx,meta.json,agent-integration.mdx,next.config.mjs,ResourceCard.tsxto their pre-feat(docs): Add MCP improvements / improve MCP local command flakiness #1608 statemcp.mdx,get_workspace_details, etc.) are not revertedTest plan
Summary by CodeRabbit