Fix dead documentation links in README#4
Conversation
Fixed: - README.md: Changed "Getting Started" → "Quick Start" (docs/quick-start.md) - README.md: Fixed "Core Concepts" path (docs/concepts/) - README.md: Fixed "API Reference" path (docs/api/) - CONTRIBUTING.md: Fixed example path to use correct directory name These directory names didn't match the actual repository structure: - docs/getting-started/ doesn't exist (should be docs/quick-start.md) - docs/core-concepts/ doesn't exist (should be docs/concepts/) - docs/api-reference/ doesn't exist (should be docs/api/) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
📝 WalkthroughWalkthroughDocumentation structure reorganized across two files. Getting Started section renamed to Quick Start with path updated to Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
Summary
Fixes dead internal links in README.md and CONTRIBUTING.md that were pointing to non-existent directory names.
Changes
README.md:
[Getting Started](docs/getting-started/)→[Quick Start](docs/quick-start.md)[Core Concepts](docs/core-concepts/)→[Core Concepts](docs/concepts/)[API Reference](docs/api-reference/)→[API Reference](docs/api/)CONTRIBUTING.md:
docs/core-concepts/→docs/concepts/Problem
The documentation links were pointing to directories that don't exist in the repository:
docs/getting-started/(doesn't exist)docs/core-concepts/(doesn't exist)docs/api-reference/(doesn't exist)The actual structure is:
docs/quick-start.md(file, not directory)docs/concepts/(actual directory name)docs/api/(actual directory name)Testing
Verified all directory paths exist:
Related
These changes weren't included in PR #2 because they were committed after the merge.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.