Skip to content

Docs: Clarify AI tool compatibility and expand context snippet#3000

Merged
ericallam merged 3 commits intomainfrom
docs/building-with-ai-improvements
Feb 5, 2026
Merged

Docs: Clarify AI tool compatibility and expand context snippet#3000
ericallam merged 3 commits intomainfrom
docs/building-with-ai-improvements

Conversation

@D-K-P
Copy link
Member

@D-K-P D-K-P commented Feb 4, 2026

This pull request overhauls the "Building with AI" documentation section. It includes a comprehensive restructuring of the main building-with-ai page with new setup guides and troubleshooting sections, reorganizes the navigation hierarchy to elevate mcp-agent-rules as a top-level page, and updates multiple documentation pages to clarify the relationships between three AI tools: Skills, Agent Rules, and MCP Server. Changes also include formatting improvements, such as replacing italicized text with inline code formatting, and consistent additions of explanatory Note blocks and CardGroup components across related pages.

@changeset-bot
Copy link

changeset-bot bot commented Feb 4, 2026

⚠️ No Changeset found

Latest commit: f8f7985

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 4, 2026

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request substantially revises the "Building with AI" documentation: the main building-with-ai page is replaced with an expanded "Quick setup" and multi-step installation guides (MCP Server, Skills, Agent Rules), plus troubleshooting and next steps. Navigation is updated to move mcp-agent-rules out of the MCP Server subgroup to the parent Building with AI group and reorder sibling pages. Several related docs (mcp-introduction, mcp-tools, mcp-agent-rules, skills) receive content and formatting changes (Note blocks, CardGroup components, inline code formatting) and updated examples.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is largely incomplete, containing only placeholder sections with checkboxes unchecked and empty Testing, Changelog, and Screenshots sections that were never filled in. Complete all required sections: fill in the issue number, check items after verifying completion, add concrete testing steps, write a detailed changelog, and include relevant screenshots if applicable.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title clearly summarizes the main objective of the PR: clarifying relationships between AI tools and expanding documentation structure.

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/building-with-ai-improvements

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b53dfcb and f8f7985.

📒 Files selected for processing (1)
  • docs/docs.json

✏️ Tip: You can disable this entire section by setting review_details to false in your review 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

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 2 additional flags.

Open in Devin Review

@D-K-P D-K-P changed the title Clarify AI tool compatibility and expand context snippet Docs: Clarify AI tool compatibility and expand context snippet Feb 4, 2026
@ericallam ericallam merged commit b96a0b7 into main Feb 5, 2026
7 of 8 checks passed
@ericallam ericallam deleted the docs/building-with-ai-improvements branch February 5, 2026 23:22
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