Skip to content

[Docs] Fix broken/empty links and typos in CONTRIBUTING.md and README.md - #8148

Merged
hiyach28 merged 3 commits into
layer5io:masterfrom
ayushgade06:fix/8137-contributing-readme-links
Sep 29, 2026
Merged

hiyach28 merged 3 commits into
layer5io:masterfrom
ayushgade06:fix/8137-contributing-readme-links

Conversation

@ayushgade06

@ayushgade06 ayushgade06 commented Sep 27, 2026 •

Copy link
Copy Markdown
Contributor

Description

This PR fixes #8137

CONTRIBUTING.md: corrected the malformed hhttps:// Sistent repo URL (extra leading h) and added the missing space before "label" so sistent)label renders as two words.

README.md: filled in the two empty href="" attributes on the Cloud Native Catalog image and text links, pointing both to https://cloud.layer5.io/catalog (matching the existing section heading link).

Notes for Reviewers

3 lines changed across 2 files... no other edits. Both destination links verified live (HTTP 200):

Signed commits

  • Yes, I signed my commits.

Summary by CodeRabbit

  • Documentation
    • Corrected repository and label links in the contribution instructions.
    • Updated the Cloud Native Catalog image and title links to open the catalog page.

CONTRIBUTING.md: correct the malformed 'hhttps://' Sistent repo URL and add
the missing space before 'label'.

README.md: point the two empty href attributes on the Cloud Native Catalog
image and text links to https://cloud.layer5.io/catalog.

Signed-off-by: Ayush Gade <ayushgade23@gmail.com>
@coderabbitai

coderabbitai Bot commented Sep 27, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 4557235a-1954-4ad7-aa78-07d8aa98aec4

📥 Commits

Reviewing files that changed from the base of the PR and between 41438d7 and 7f462bd.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 1699e78a-f579-4d83-aac0-2331b98f9c9b

📥 Commits

Reviewing files that changed from the base of the PR and between b001045 and 3e02a88.

📒 Files selected for processing (2)
  • CONTRIBUTING.md
  • README.md

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


📝 Walkthrough

Walkthrough

Corrected the Sistent repository link and spacing in CONTRIBUTING.md. Updated the Cloud Native Catalog image and title links in README.md to point to the catalog page.

Changes

Root documentation corrections

Layer / File(s) Summary
Correct root documentation links
CONTRIBUTING.md, README.md
Corrected the Sistent repository URL and spacing. Set both Cloud Native Catalog links to https://cloud.layer5.io/catalog.

Priority: ⬇️ Low

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

Change: Other · Severity of issue fixed: Low

Suggested reviewers: leecalcote

Merge Risk: ⚪ Minimal · up to 41438

The requested documentation corrections are narrowly scoped, with no identified issue that should block merging.

Architecture Summary

Architecture risk: 🔵 Low · up to 3e02a

The change affects 2 systems.

Changed systems: CONTRIBUTING.md, README.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — CONTRIBUTING.md (service) was modified; 1 changed file maps to changed impact.
  • observed — README.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in CONTRIBUTING.md: The Sistent contribution link text now includes a space before “label,” and the repository URL no longer has an extra leading h.
  • observed — Modified behavior in README.md: The catalog image and title links now target https://cloud.layer5.io/catalog; both previously had empty href values.
🚥 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 clearly summarizes the documentation changes by identifying broken or empty links and typos in the two modified files.
Linked Issues check ✅ Passed PR #8148 implements all coding requirements from directly linked issue #8137. It corrects the Sistent repository URL and adds the missing space before “label” in CONTRIBUTING.md. It changes both emp…
Out of Scope Changes check ✅ Passed The changes are limited to the two documentation files and the link and spacing corrections requested by issue #8137. The PR summary identifies no unrelated source, test, configuration, or generated-f…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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.

@piyushtripathi9424 piyushtripathi9424 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Reviewed the changes. The malformed Sistent repository URL and missing space in CONTRIBUTING.md are corrected, and both Cloud Native Catalog links in README.md now point to the correct destination.

The changes are minimal, scoped to the reported documentation issues, and introduce no apparent regressions.

LGTM! Thanks for fixing these documentation issues.

@hiyach28 hiyach28 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks, looks good. Fixes all four items from issue, and I didn't spot any other empty hrefs or broken links in either file.

@hiyach28
hiyach28 merged commit c7dd360 into layer5io:master Sep 29, 2026
5 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

Preview deployment for PR #8148 removed.

This PR preview was automatically pruned because we keep only the 3 most recently updated previews on GitHub Pages to stay within deployment size limits.

If needed, push a new commit to this PR to generate a fresh preview.

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.

[Docs] Fix broken/empty links and typos in CONTRIBUTING.md and README.md

4 participants