docs: hyperlink reference docs in guides and snippets (CPK-4143)

[tylerslaton]

Summary by CodeRabbit

• Documentation
  • Expanded component examples for CopilotPopup, CopilotSidebar, CopilotChat, and Headless UI with clearer JSX/TSX snippets and direct links to references.
  • Converted plain hook/component mentions to clickable Markdown links across docs (e.g., useCopilotChat, useCopilotAction, useCopilotChatSuggestions, useCopilotChatHeadless_c).
  • Clarified behavior of useCopilotChatSuggestions, noting instruction-driven updates based on monitored state.
  • Updated warning callout to include linked references for related components/hooks.
  • Improved navigability and consistency in premium headless UI docs with comprehensive link updates.

[changesets-bot-copilotkit[bot]]

⏭️ Changeset Not Required

Latest commit: 62c73a1ecbffc6bf7ff15c412f8d9e7184b30a7f

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.

[coderabbitai[bot]]

Walkthrough

Documentation updates across multiple MDX snippets to add explicit Markdown links to component and hook references, expand/clarify example code, and refine explanatory text. No code or API signatures changed; all edits are content-only within docs.

Changes

Cohort / File(s)	Summary
Component examples docs docs/snippets/component-examples.mdx	Replaced plain references with Markdown links for Copilot UI components/hooks; expanded/added JSX/TSX examples for CopilotPopup, CopilotSidebar, CopilotChat; added detailed Headless UI example using useCopilotChat; updated inline descriptions.
Headless UI snippet docs/snippets/headless-ui.mdx	Converted inline code reference to a Markdown link for useCopilotChat.
Self-hosting runtime warning links docs/snippets/self-hosting-copilot-runtime-create-endpoint.mdx	Updated error callout to use Markdown links for useCopilotChatSuggestions, CopilotTextarea, and CopilotTask.
Suggestions guide docs/snippets/shared/guides/copilot-suggestions.mdx	Added clarifying sentence about instructions guiding suggestion generation and updates based on monitored relevantState.
Premium headless UI links docs/snippets/shared/premium/headless-ui.mdx	Standardized hook references to Markdown links for useCopilotChatHeadless_c, useCopilotAction, and useCopilotChatSuggestions across headings, comments, and inline text.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• CopilotKit/CopilotKit#2292 — Similar documentation link-format updates for premium/headless UI snippets, including useCopilotChatHeadless_c.
• CopilotKit/CopilotKit#2140 — Related docs changes around Copilot suggestions and the useCopilotChatSuggestions hook.

Suggested labels

preview

Suggested reviewers

• suhasdeshpande
• ataibarkai
• ranst91
• mme

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 title accurately captures the primary change by indicating that documentation guides and snippet files have been updated to include hyperlink references, and it directly corresponds to the modifications described in the pull request. It is concise, clear, and specific enough for teammates to understand the main purpose of the changes without unnecessary detail or noise.
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

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[vercel[bot]]

@cursoragent is attempting to deploy a commit to the CopilotKit Team on Vercel.

A member of the Team first needs to authorize it.

[tylerslaton]

@cursoragent you didn't do this across integrations could you please do that?