Skip to content

docs: add back-navigation link to cpp-linter hub#445

Merged
shenxianpeng merged 6 commits into
mainfrom
fix/add-back-navigation
Jun 9, 2026
Merged

docs: add back-navigation link to cpp-linter hub#445
shenxianpeng merged 6 commits into
mainfrom
fix/add-back-navigation

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Jun 8, 2026

Copy link
Copy Markdown
Member

Adds ← Back to cpp-linter hub navigation link in both:\n- The MkDocs site nav\n- The README.md\n\nThis makes it easy for users to navigate back to the central hub from the cpp-linter-action documentation.

Summary by CodeRabbit

  • Documentation
    • Added a "cpp-linter hub" badge/link to the project README header.
    • Updated site navigation to include a link to the cpp-linter hub, making the external hub more discoverable from the documentation site.

@shenxianpeng shenxianpeng requested a review from a team as a code owner June 8, 2026 17:03
@shenxianpeng shenxianpeng requested review from 2bndy5 and removed request for a team June 8, 2026 17:03
@coderabbitai

coderabbitai Bot commented Jun 8, 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4be98c6c-f157-414c-8668-4b84d10d7441

📥 Commits

Reviewing files that changed from the base of the PR and between d5dff2b and d57783f.

📒 Files selected for processing (1)
  • mkdocs.yml
✅ Files skipped from review due to trivial changes (1)
  • mkdocs.yml

Walkthrough

Adds a cpp-linter hub badge to the README header and a navigation entry in mkdocs.yml; both link to https://cpp-linter.github.io/.

Changes

Documentation and navigation links to cpp-linter hub

Layer / File(s) Summary
README badge and MkDocs nav entry
README.md, mkdocs.yml
Inserted a GitHub-style “cpp-linter hub” badge linking to https://cpp-linter.github.io/ in the README header and added a navigation entry labeled “← cpp-linter org” to mkdocs.yml that points to the same site.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • cpp-linter/cpp-linter-action#442: Both PRs update README.md to add new cpp-linter ecosystem documentation links (this PR adds a cpp-linter hub badge/link, the related PR adds a TIP cross-reference to cpp-linter-hooks).

Suggested labels

documentation

Suggested reviewers

  • 2bndy5
🚥 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 describes the main change: adding a back-navigation link to the cpp-linter hub in documentation files (README.md and mkdocs.yml).
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/add-back-navigation

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.

@github-actions github-actions Bot added bug Something isn't working documentation Improvements or additions to documentation labels Jun 8, 2026
Comment thread mkdocs.yml Outdated
Co-authored-by: Brendan <2bndy5@gmail.com>
Comment thread mkdocs.yml Outdated

@2bndy5 2bndy5 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.

Image

@shenxianpeng shenxianpeng merged commit f133489 into main Jun 9, 2026
8 checks passed
@shenxianpeng shenxianpeng deleted the fix/add-back-navigation branch June 9, 2026 06:50
@shenxianpeng shenxianpeng removed the bug Something isn't working label Jun 9, 2026
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