docs: fix broken link and duplicate heading in README#107
Conversation
- Replace broken CLIENT_SDK_GUIDE.md link with Getting Started CLI docs URL - Remove duplicate "Setting Up Development Environment" heading Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
📝 WalkthroughWalkthroughDocumentation updates to README.md adjusting references and section headings. A local SDK guide reference is replaced with an external CLI link, and a redundant development section heading is removed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
1-634: Consider running a comprehensive link check.Since this PR fixes a broken link, it would be valuable to scan the entire README for other potentially broken links to prevent similar issues.
🔗 Suggested script to check all links in README
#!/bin/bash # Description: Extract and validate all URLs from README.md echo "Checking HTTP/HTTPS links..." # Extract all http/https URLs rg -o 'https?://[^\s\)]+' README.md | sort -u | while read -r url; do echo -n "Checking $url ... " status=$(curl -s -o /dev/null -w "%{http_code}" -L "$url" --max-time 10) if [ "$status" = "200" ]; then echo "✓ OK" else echo "✗ Status: $status" fi done echo "" echo "Checking local file references..." # Check for references to local .md files rg -o '\[([^\]]+)\]\(([^)]+\.md)\)' README.md -r '$2' | sort -u | while read -r file; do if [ -f "$file" ]; then echo "✓ $file exists" else echo "✗ $file not found" fi done🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 1 - 634, Run a comprehensive link validation of README.md (the top-level README) to find and fix any broken HTTP/HTTPS links and local file references mentioned (e.g., the "Getting Started with the CLI" link, badges/anchors, and example paths like examples/simple_adapter/simple_adapter.py); use the provided shell script or a link-checker tool to list failing URLs, update incorrect URLs or restore missing local files/paths, then re-run the check to confirm all links return 200/are present and commit the updated README.md.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@README.md`:
- Around line 1-634: Run a comprehensive link validation of README.md (the
top-level README) to find and fix any broken HTTP/HTTPS links and local file
references mentioned (e.g., the "Getting Started with the CLI" link,
badges/anchors, and example paths like
examples/simple_adapter/simple_adapter.py); use the provided shell script or a
link-checker tool to list failing URLs, update incorrect URLs or restore missing
local files/paths, then re-run the check to confirm all links return 200/are
present and commit the updated README.md.
Summary
CLIENT_SDK_GUIDE.mdlink with the Getting Started CLI docs URL (https://eval-hub.github.io/getting-started/cli/)### Setting Up Development Environmentheading (kept### Development Setup)Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit