Skip to content

docs:fix readme's wrong doc link. - #2596

Merged
goldmedal merged 1 commit into
Canner:mainfrom
binarytom:fix/readme-link-invalid
Jul 28, 2026
Merged

goldmedal merged 1 commit into
Canner:mainfrom
binarytom:fix/readme-link-invalid

Conversation

@binarytom

@binarytom binarytom commented Jul 27, 2026 •

Copy link
Copy Markdown
Contributor

The [Architecture map] in Readme with a wrong link.

Summary by CodeRabbit

  • Documentation
    • Updated the Contributing section’s Architecture map link to the current documentation location.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 27, 2026
@coderabbitai

coderabbitai Bot commented Jul 27, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 8dcca8f0-d658-4d1f-8d1c-311baee71751

📥 Commits

Reviewing files that changed from the base of the PR and between 06e4c42 and 2a6fed3.

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

Walkthrough

The README’s Contributing section updates the Architecture map link from the former documentation path to ./docs/core/reference/architecture.md.

Changes

README Documentation

Layer / File(s) Summary
Update architecture map link
README.md
The Contributing section now links to the architecture documentation at its newer path.

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

Possibly related PRs

Suggested reviewers: goldmedal, chilijung

Poem

A bunny hops where old links lay,
And nudges one to docs today.
The architecture path is bright,
Pointing readers left and right.
One tiny change, then off I race—
To map the code’s delightful place!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the README documentation link fix described in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@goldmedal goldmedal left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks @binarytom 👍

@goldmedal
goldmedal merged commit fcd8c02 into Canner:main Jul 28, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants