Skip to content

docs: fix contributing guide links#1312

Merged
muddlebee merged 1 commit intoTracer-Cloud:mainfrom
aayushprsingh:docs/fix-contributing-links
May 5, 2026
Merged

docs: fix contributing guide links#1312
muddlebee merged 1 commit intoTracer-Cloud:mainfrom
aayushprsingh:docs/fix-contributing-links

Conversation

@aayushprsingh
Copy link
Copy Markdown
Contributor

Summary

  • remove a Quick Links entry that pointed to missing VISION.md
  • fix the rendered X/Twitter link text
  • render the devcontainer path as a normal Markdown link

Verification

  • git diff --check
  • targeted Python assertion over CONTRIBUTING.md link cleanup

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 5, 2026

Greptile Summary

  • Removes the broken VISION.md Quick Link (the file does not exist in the repo), fixes the X/Twitter entry by stripping the stray § character, and converts the devcontainer path from a backtick-escaped literal to a rendered Markdown link.
  • All three changes are purely cosmetic/documentation corrections with no impact on code behaviour.

Confidence Score: 5/5

Safe to merge — documentation-only corrections with no code or behavioural changes.

All three changes are straightforward Markdown fixes. VISION.md is confirmed absent from the repo, so removing its link is correct. The § removal and backtick unwrap are clearly right. No logic, tests, or APIs are touched.

No files require special attention.

Important Files Changed

Filename Overview
CONTRIBUTING.md Three documentation fixes: removed dead VISION.md Quick Link, stripped stray § from X/Twitter entry, and corrected devcontainer path from inline-code-wrapped to a proper Markdown hyperlink.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[CONTRIBUTING.md Quick Links] -->|Before| B["§[@open_sre] + broken VISION.md + backtick devcontainer"]
    A -->|After| C["[@open_sre] link only + devcontainer as proper link"]
    B -->|Fix 1| D[Remove VISION.md entry — file does not exist]
    B -->|Fix 2| E[Strip stray § from X/Twitter entry]
    B -->|Fix 3| F[Unwrap devcontainer path — render as Markdown link]
    D --> C
    E --> C
    F --> C
Loading

Reviews (1): Last reviewed commit: "docs: fix contributing guide links" | Re-trigger Greptile

@muddlebee muddlebee merged commit e5f9a48 into Tracer-Cloud:main May 5, 2026
@muddlebee
Copy link
Copy Markdown
Collaborator

@aayushprsingh thank you for PR. welcome to openSRE 🚀

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026

🧑‍💻 @aayushprsingh has entered the contributor hall of fame. Merged. Done. Shipped. Go touch grass (then come back with another PR). 🌱


👋 Join us on Discord - OpenSRE : hang out, contribute, or hunt for features and issues. Everyone's welcome.

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.

2 participants