Skip to content
This repository was archived by the owner on Mar 2, 2026. It is now read-only.

Fix dead documentation links in README#4

Merged
simons-plugins merged 1 commit into
mainfrom
fix-readme-dead-links
Jan 28, 2026
Merged

Fix dead documentation links in README#4
simons-plugins merged 1 commit into
mainfrom
fix-readme-dead-links

Conversation

@simons-plugins

@simons-plugins simons-plugins commented Jan 28, 2026

Copy link
Copy Markdown
Owner

Summary

Fixes dead internal links in README.md and CONTRIBUTING.md that were pointing to non-existent directory names.

Changes

README.md:

  • Changed [Getting Started](docs/getting-started/)[Quick Start](docs/quick-start.md)
  • Changed [Core Concepts](docs/core-concepts/)[Core Concepts](docs/concepts/)
  • Changed [API Reference](docs/api-reference/)[API Reference](docs/api/)

CONTRIBUTING.md:

  • Changed example path from 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:

ls -d docs/*/
# docs/api/
# docs/concepts/
# docs/examples/
# docs/patterns/
# docs/troubleshooting/

ls docs/quick-start.md
# docs/quick-start.md

Related

These changes weren't included in PR #2 because they were committed after the merge.

Summary by CodeRabbit

  • Documentation
    • Reorganized documentation structure with updated navigation paths and section names for improved discoverability and consistency across guides.

✏️ Tip: You can customize this high-level summary in your review settings.

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>
@coderabbitai

coderabbitai Bot commented Jan 28, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Documentation structure reorganized across two files. Getting Started section renamed to Quick Start with path updated to docs/quick-start.md. Core Concepts reorganized to docs/concepts/ and API Reference restructured to docs/api/. Navigation text and paths updated to reflect new directory structure.

Changes

Cohort / File(s) Summary
Documentation Path Reorganization
CONTRIBUTING.md, README.md
Updated documentation paths: docs/core-concepts/docs/concepts/, docs/getting-started/docs/quick-start.md, docs/api-reference/docs/api/. Section titles adjusted to match new structure. Changes applied consistently across navigation references.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 Hops through docs with glee so bright,
Paths reorganized, everything's right,
Concepts and API in new homes they rest,
Quick Start's adventure puts readers to test,
A cleaner garden for knowledge to grow! 🌱

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: fixing dead documentation links in README.md (and also CONTRIBUTING.md).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@simons-plugins simons-plugins merged commit 764244f into main Jan 28, 2026
1 of 4 checks passed
@simons-plugins simons-plugins deleted the fix-readme-dead-links branch January 28, 2026 18:42
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant