Skip to content

docs: fix broken links to crewAI-examples notebooks#6193

Open
putramkti wants to merge 1 commit into
crewAIInc:mainfrom
putramkti:docs/fix-broken-examples-links
Open

docs: fix broken links to crewAI-examples notebooks#6193
putramkti wants to merge 1 commit into
crewAIInc:mainfrom
putramkti:docs/fix-broken-examples-links

Conversation

@putramkti

@putramkti putramkti commented Jun 16, 2026

Copy link
Copy Markdown

Fix broken links to crewAI-examples notebooks

Problem

Two links in the README's performance comparison section point to non-existent paths in the crewAI-examples repo:

  • QA Agent example → returns 404
  • Coding Assistant notebook → returns 404

The paths use Notebooks/CrewAI Flows & Langgraph/... but the actual directory structure is notebooks/... (lowercase, no intermediate CrewAI Flows & Langgraph folder).

Fix

Updated both URLs to use the correct paths:

  • tree/main/Notebooks/CrewAI%20Flows%20%26%20Langgraph/QA%20Agenttree/main/notebooks/QA%20Agent
  • blob/main/Notebooks/CrewAI%20Flows%20%26%20Langgraph/Coding%20Assistant/coding_assistant_eval.ipynbblob/main/notebooks/Coding%20Assistant/coding_assistant_eval.ipynb

Verification

Both corrected URLs verified working (HTTP 200):

Note: A prior PR (#3875) attempted the same fix but was closed due to inactivity.

Summary by CodeRabbit

  • Documentation
    • Updated reference links in the README to point to example notebooks, ensuring consistent and accurate resources for exploring LangGraph QA tasks and coding assistant evaluations.

The links to QA Agent and Coding Assistant examples were pointing to
non-existent paths (Notebooks/CrewAI Flows & Langgraph/...).
The actual directory structure uses notebooks/ (lowercase) without
the CrewAI Flows & Langgraph intermediate folder.

Verified both corrected URLs return 200.
@coderabbitai

coderabbitai Bot commented Jun 16, 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: be491dac-ce5f-49bb-b3fe-32fbdce330eb

📥 Commits

Reviewing files that changed from the base of the PR and between 9d44d0a and 02d32e2.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

One line in README.md is updated: the two notebook URLs in the "P.S." comparison sentence are changed to corrected paths pointing to the QA Agent and coding assistant evaluation notebooks.

Changes

README comparison link correction

Layer / File(s) Summary
Update P.S. comparison notebook URLs
README.md
Replaces the see comparison and detailed analysis URLs in the P.S. section with updated notebook paths for the QA Agent and coding assistant evaluation examples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 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 'docs: fix broken links to crewAI-examples notebooks' accurately summarizes the main change—fixing broken documentation links in the README.
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

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.

1 participant