CopilotKit icon indicating copy to clipboard operation
CopilotKit copied to clipboard

remove install-sdk from docs where not relevant (and cleanup unused i…

Open maxkorp opened this issue 3 months ago • 5 comments

What does this PR do?

There are a number of references in the doc to installing the langgraph sdk where it's not applicable (meaning, in docs for other frameworks). This removes those, and also removes unused imports of the sdk install component in a bunch of files

Checklist

  • [x] I have read the Contribution Guide
  • [x] If the PR changes or adds functionality, I have updated the relevant documentation

Summary by CodeRabbit

  • Documentation
    • Removed SDK installation snippets across multiple guides (Frontend Actions, Human-in-the-Loop, Generative UI, and Advanced topics) for AG2, CrewAI, LangGraph, LlamaIndex, Mastra, and Pydantic-AI, streamlining the flow.
    • Cleaned up formatting: standardized callouts, trimmed trailing whitespace, fixed placeholder comment spacing, and removed extraneous blank lines.
    • Ensured consistent step sequences and proper document endings.
    • No changes to example behavior or public APIs.

maxkorp avatar Sep 18 '25 21:09 maxkorp

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Sep 18, 2025 9:38pm
examples-coagents-ai-travel-app Ready Ready Preview Comment Sep 18, 2025 9:38pm
examples-coagents-research-canvas-ui Ready Ready Preview Comment Sep 18, 2025 9:38pm
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
examples-coagents-ai-researcher-ui Ignored Ignored Sep 18, 2025 9:38pm

vercel[bot] avatar Sep 18 '25 21:09 vercel[bot]

⏭️ Changeset Not Required

Latest commit: 90f37ae275c23eb1fb787df99da9ec4a98054468

No changes in this PR affected the @copilitkit/* packages. Merging this PR will not cause a version bump for any packages.

Changeset is not required for this PR.

Walkthrough

The PR removes imports and embedded usage of the InstallSDKSnippet across multiple documentation pages and performs minor whitespace/formatting cleanups. Several pages also delete the full “Install the CopilotKit SDK” step. No code logic or public API changes.

Changes

Cohort / File(s) Summary
Remove InstallSDKSnippet import and install step
docs/content/docs/ag2/frontend-actions.mdx, docs/content/docs/crewai-crews/human-in-the-loop/flow.mdx, docs/content/docs/crewai-flows/advanced/disabling-state-streaming.mdx, docs/content/docs/llamaindex/frontend-actions.mdx, docs/content/docs/llamaindex/human-in-the-loop/tool-based.mdx, docs/content/docs/pydantic-ai/human-in-the-loop/agent.mdx
Deleted InstallSDKSnippet import and removed the embedded installation Step/snippet. Minor formatting adjustments where applicable.
Remove InstallSDKSnippet import only
docs/content/docs/ag2/human-in-the-loop/hitl.mdx, docs/content/docs/crewai-crews/advanced/exit-agent.mdx, docs/content/docs/crewai-crews/frontend-actions.mdx, docs/content/docs/crewai-crews/generative-ui/agentic.mdx, docs/content/docs/crewai-flows/generative-ui/agentic.mdx, docs/content/docs/langgraph/advanced/disabling-state-streaming.mdx, docs/content/docs/langgraph/generative-ui/agentic.mdx, docs/content/docs/pydantic-ai/frontend-actions.mdx, docs/content/docs/pydantic-ai/generative-ui/agentic.mdx
Removed unused InstallSDKSnippet import lines; content otherwise unchanged aside from minor whitespace tweaks in some files.
Formatting/whitespace only
docs/content/docs/langgraph/shared-state/predictive-state-updates.mdx, docs/content/docs/mastra/human-in-the-loop/tool-based.mdx
Whitespace and formatting cleanup in prose/code blocks; no content or structural changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • CopilotKit/CopilotKit#1883 — Also edits docs/content/docs/crewai-flows/advanced/disabling-state-streaming.mdx; related due to overlapping file and example adjustments.

Suggested labels

preview

Suggested reviewers

  • tylerslaton
  • ataibarkai
  • ranst91
  • suhasdeshpande

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The PR title succinctly describes the primary change—removing install-sdk references from documentation and cleaning up unused imports—and matches the diffs that remove InstallSDKSnippet imports and related steps across multiple MDX files, so it is concise, relevant, and understandable at a glance.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment
  • [ ] Commit unit tests in branch max/fix-sdk-docs

[!TIP]

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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.

coderabbitai[bot] avatar Sep 18 '25 21:09 coderabbitai[bot]

Previews

Commit SHA: ee11601

Name Preview
coagents-research-canvas PreviewPreview with LGC PythonPreview with LGC JS
coagents-qa-native PreviewPreview with LGC PythonPreview with LGC JS
coagents-routing PreviewPreview with LGC PythonPreview with LGC JS
coagents-qa-text PreviewPreview with LGC PythonPreview with LGC JS
next-openai Preview

github-actions[bot] avatar Sep 18 '25 21:09 github-actions[bot]

Test Results

Status: ✅ Passed (View Run)

Commit: ee11601

Duration: 249.5s

Total Tests: 37

Pass Rate: 100.0%

Failed Tests: 0

🔍 Detailed Results

coagents-research-canvas

CoAgents Research Canvas (UI) - Local Depenencies

Model Browser Status Video
OpenAI chromium ✅ PASSED -
Anthropic chromium ✅ PASSED -
CrewAI chromium ✅ PASSED -

coagents-qa-native

CoAgents QA Native (UI) - Local

Model Browser Status Video
OpenAI chromium ✅ PASSED -
Anthropic chromium ✅ PASSED -

coagents-qa-text

CoAgents QA Text (UI) - Local

Model Browser Status Video
OpenAI chromium ✅ PASSED -
Anthropic chromium ✅ PASSED -
OpenAI (LGC Python) chromium ✅ PASSED -
Anthropic (LGC Python) chromium ✅ PASSED -
OpenAI (LGC JS) chromium ✅ PASSED -
Anthropic (LGC JS) chromium ✅ PASSED -

coagents-routing

CoAgents Routing (UI) - Local

Model Browser Status Video
OpenAI chromium ✅ PASSED -
Anthropic chromium ✅ PASSED -

next-openai

Next OpenAI - Self Hosted

Model Browser Status Video
OpenAI chromium ✅ PASSED -
Anthropic chromium ✅ PASSED -
LangChain (OpenAI) chromium ✅ PASSED -
Groq chromium ✅ PASSED -

github-actions[bot] avatar Sep 18 '25 21:09 github-actions[bot]