Skip to content

docs: fix broken link and duplicate heading in README#107

Merged
julpayne merged 1 commit intomainfrom
ambient/session-5667579f-852c-47f1-a1ba-fbe3f3504464
Apr 1, 2026
Merged

docs: fix broken link and duplicate heading in README#107
julpayne merged 1 commit intomainfrom
ambient/session-5667579f-852c-47f1-a1ba-fbe3f3504464

Conversation

@tarilabs
Copy link
Copy Markdown
Member

@tarilabs tarilabs commented Apr 1, 2026

Summary

Test plan

  • Verify the new link resolves correctly
  • Confirm no other broken links remain

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated package organization documentation to reference the external "Getting Started with the CLI" guide.
    • Simplified development section structure for improved clarity.

- 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>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 1, 2026

📝 Walkthrough

Walkthrough

Documentation 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

Cohort / File(s) Summary
Documentation Updates
README.md
Updated "Package Organization" section reference from local CLIENT_SDK_GUIDE.md to external "Getting Started with the CLI" link; removed redundant "Setting Up Development Environment" subheading under "Development" section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 With whiskers twitched and paws so light,
I've tidied docs to set things right—
Old guides replaced, headers refined,
A cleaner path for all to find! 🌿

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main changes: fixing a broken link and removing a duplicate heading in the README, which aligns with the actual changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed PR description addresses all required sections: objective (fixing broken link and duplicate heading), type (docs), and testing (link verification performed).

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ambient/session-5667579f-852c-47f1-a1ba-fbe3f3504464

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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7252dd2c-af00-42d4-97ec-d1c165be674f

📥 Commits

Reviewing files that changed from the base of the PR and between 1683253 and 6b14e81.

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

@julpayne julpayne merged commit 5bfb8f9 into main Apr 1, 2026
13 checks passed
@julpayne julpayne deleted the ambient/session-5667579f-852c-47f1-a1ba-fbe3f3504464 branch April 1, 2026 11:00
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.

3 participants