Skip to content

docs: improve coding agent setup CTA#6344

Merged
joaomdmoura merged 3 commits into
mainfrom
codex/improve-coding-agent-cta
Jun 26, 2026
Merged

docs: improve coding agent setup CTA#6344
joaomdmoura merged 3 commits into
mainfrom
codex/improve-coding-agent-cta

Conversation

@joaomdmoura

@joaomdmoura joaomdmoura commented Jun 26, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Replace the weak installation-page text CTA with a prominent coding-agent setup panel
  • Style the copy/setup CTA directly so it renders as an actual button
  • Add a direct link to the Build with AI coding-agent guide from the CTA area

Docs versioning

This edits docs/edge/en/... only. Once merged to main, it appears under the Edge version selector. It will be frozen into the next released docs version when the release-cut docs freeze runs.

Verification

  • git diff --check
  • python -m json.tool docs/docs.json
  • Compiled edited MDX files with @mdx-js/mdx

Note: mintlify broken-links and mintlify dev started locally but did not complete in this environment.


Note

Low Risk
Documentation and client-side clipboard UI only; no runtime, auth, or data-path changes.

Overview
Docs-only UX for getting started with CrewAI in coding agents: stronger CTAs on the installation page and docs home.

On installation.mdx, the old plain copy button is now a highlighted “coding agent setup” panel (headline, short explanation, branded styling). The copy-to-clipboard action is an explicit primary button with clearer label (“Copy agent setup prompt”), plus a “View coding-agent guide” link to /en/guides/coding-tools/build-with-ai. Clipboard feedback now clears pending reset timers before starting a new copy so rapid clicks don’t leave the label stuck.

On index.mdx, the hero replaces Mintlify button classes with inline-styled links/buttons. It adds the same copy agent setup prompt control and a coding-agent guide link; changelog is dropped from the hero in favor of Get started, copy prompt, guide, and API Reference.

Reviewed by Cursor Bugbot for commit eb372ea. Bugbot is set up for automated code reviews on this repo. Configure here.

Summary by CodeRabbit

  • New Features

    • Added a “Copy agent setup prompt” button to documentation CTAs/callouts for one-click setup prompt copying.
    • Added a direct “Coding-agent guide” link from the getting-started and installation areas.
    • Removed the previous “View changelog” link and the older coding-agent copy button.
  • UI Improvements

    • Refreshed the installation and homepage getting-started CTAs with a more guided layout and clearer next steps.
  • Bug Fixes

    • Enhanced clipboard copy feedback with clear success/failure messaging and automatic reset of the button state.

@mintlify

mintlify Bot commented Jun 26, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
crewai 🟢 Ready View Preview Jun 26, 2026, 7:03 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@corridor-security corridor-security Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Summary: This PR updates documentation MDX with static CTA styling, internal documentation links, and a clipboard-copy setup prompt. No exploitable security vulnerabilities were identified.

Risk: Low risk. The changes do not introduce new authentication, authorization, data handling, server-side processing, or externally controlled script execution paths.

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 3e041f37-9d63-430e-846d-ea9424c779c9

📥 Commits

Reviewing files that changed from the base of the PR and between bc00518 and eb372ea.

📒 Files selected for processing (2)
  • docs/edge/en/installation.mdx
  • docs/index.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/index.mdx
  • docs/edge/en/installation.mdx

📝 Walkthrough

Walkthrough

The docs landing page and installation page replace older CTA links with coding-agent setup prompt buttons, clipboard feedback, and updated navigation links.

Changes

Coding agent docs updates

Layer / File(s) Summary
Hero CTA and prompt links
docs/index.mdx
The top CTA area replaces the old button links with a Get started link, a clipboard-copy prompt button, and Coding-agent guide/API Reference links.
Setup callout and clipboard feedback
docs/edge/en/installation.mdx
The installation intro replaces the Watch lead with a coding-agent setup callout and updates prompt copy success/failure labels with a timed reset.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is concise and accurately reflects the main change: improving the coding agent setup CTA in docs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/improve-coding-agent-cta

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.

Comment thread docs/edge/en/index.mdx Outdated

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit bc00518. Configure here.

Comment thread docs/index.mdx

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/index.mdx`:
- Around line 108-110: The label reset in the copy-button flow can be
interrupted by overlapping clicks because the timeout scheduled in the copy
handler is never cleared. Update the click handling around the button in the
docs index script so any previously stored reset timer is cleared before
scheduling a new one, and make sure the timeout ID is retained between clicks.
Keep the existing feedback states in the same handler and only reset the label
after the latest click’s delay has fully elapsed.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 1ec9624c-265a-48f5-8759-1e6284b8a824

📥 Commits

Reviewing files that changed from the base of the PR and between f5313bf and bc00518.

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

Comment thread docs/index.mdx Outdated

@alex-clawd alex-clawd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good. Docs-only, checks green, low risk.

@alex-clawd alex-clawd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Approved again.

@joaomdmoura joaomdmoura merged commit 2771c02 into main Jun 26, 2026
58 checks passed
@joaomdmoura joaomdmoura deleted the codex/improve-coding-agent-cta branch June 26, 2026 08:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants