Skip to content

docs: point both readmes at the docs index - #6

Merged
yordis merged 2 commits into
mainfrom
yordis/docs-index-readme
Oct 30, 2026
Merged

yordis merged 2 commits into
mainfrom
yordis/docs-index-readme

Conversation

@yordis

@yordis yordis commented Oct 30, 2026 •

Copy link
Copy Markdown
Member
  • The section list was duplicated across both readmes and the docs index, so every new section had to be added in three places and the npm readme had already drifted.

…in one place

Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
@coderabbitai

coderabbitai Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: bba48bd6-1b6a-482b-994a-7e52a8af28a7
Commits

Reviewing files that changed from the base of the PR and between 98921b3 and e154d21.

Files selected for processing: 3
  • CONTRIBUTING.md
  • README.md
  • packages/next-nats/README.md
Files with no reviewable changes: 1
  • CONTRIBUTING.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The root and package READMEs replace several documentation links with a link to docs/README.md. The root README removes its Contributing link, and CONTRIBUTING.md is deleted.

Changes

Documentation links and contributing guidance

Layer / File(s) Summary
Update documentation entry points
README.md, packages/next-nats/README.md, CONTRIBUTING.md
Both READMEs link to docs/README.md instead of listing separate documentation pages. The root README removes its Contributing link, and the contributing guide is deleted.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related PRs

Merge Risk: Minimal · up to e154d

The README links now consolidate documentation access without an identified broken entry point. No merge-blocking issue remains.

Pre-merge checks: Passed 4
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main change: both README files now point to the documentation index.
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.
Description check Passed The description explains that both README files now point to the documentation index to prevent duplicated and inconsistent section lists. This matches the documented changes.
Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

A rabbit hops past docs in view,
One index points the way through.
The guide is gone, the links align,
A tidy path in README lines.
I nibble clover, then review.

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

Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
@yordis
yordis merged commit 13f0107 into main Oct 30, 2026
5 of 6 checks passed
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