Repository navigation
[Docs] Replace dead design-doc link in CONTRIBUTING.md - #8286
sameerkrdev wants to merge 2 commits into
Conversation
The Style Guide section linked to a Google Doc that now returns HTTP 410 (deleted). Point it to the Layer5 Designs Figma file, which the issue templates and the 404 page already reference as "Layer5 site designs". Fixes layer5io#8235 Signed-off-by: Sameer Kumar <sameerkr.dev@gmail.com>
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Update the Style Guide reference CONTRIBUTING.md |
The Style Guide link and description now refer to the Layer5 site map in Figma and its page relationships and high-level data flow. |
Estimated code review effort: 1 (Trivial) | ~3 minutes
Change: Other · Severity of issue fixed: Low
Suggested reviewers: mahakgupta108
Merge Risk: 
a5dfd
-
The contribution-guide update appears ready to merge after normal checks.
Pre-merge checks: 
-
Check name Status Explanation Description Check Check skipped - CodeRabbit’s high-level summary is enabled. Title check The title "[Docs] Replace dead design-doc link in CONTRIBUTING.md" matches the single change in the changeset. The Style Guide section of CONTRIBUTING.md now links to the Layer5 Figma site map instead… Linked Issues check Issue #8235requires the dead design-document link inCONTRIBUTING.mdto point to an existing destination. The whole-PR diff replaces the Google Docs URL with the requested Layer5 Designs Figma URL …Out of Scope Changes check The whole-PR diff contains one line change in CONTRIBUTING.md. The change directly implements issue#8235. The diff contains no unrelated table-formatting changes or other out-of-scope content.Full details: Title check
-
Explanation
The title "[Docs] Replace dead design-doc link in CONTRIBUTING.md" matches the single change in the changeset. The Style Guide section of CONTRIBUTING.md now links to the Layer5 Figma site map instead of the deleted design-doc link, as described in the raw summary, linked issue
#8235, and PR objectives. The title is specific and names the file and the type of change. The title does not mention the new link's purpose (a site map), but that detail is not needed for the primary change.
Full details: Linked Issues check
-
Explanation
Issue
#8235requires the dead design-document link inCONTRIBUTING.mdto point to an existing destination. The whole-PR diff replaces the Google Docs URL with the requested Layer5 Designs Figma URL and updates the description to explain the site map. The PR description reports thatnpm run check:contributing-versionspasses.
-
Finishing Touches
-
Generate unit tests (beta)
-
- 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.
|
🚀 Preview deployment: https://layer5.io/pr-preview/pr-8286/ |
rahmanaisha
left a comment
rahmanaisha
left a comment
There was a problem hiding this comment.
Nice work - this is exactly the fix #8235 asks for, and it is ready to merge.
What works well:
- The replacement link is the right target, not just a live one: it is the same Layer5 Designs Figma file the issue templates and the 404 page already point contributors to, so CONTRIBUTING.md now agrees with the rest of the repo instead of inventing a new destination.
- The link text follows the same "Layer5 site designs" naming those pages use, so contributors see one consistent name for it everywhere.
- The build-variables table reformat is whitespace only - I compared the rows and every variable, value, and description is unchanged - and flagging it in the PR description up front was the right call.
No changes needed. Build, DCO, and triage checks are all green at this head.
…rmatting Address review on layer5io#8286: describe the Figma link as the Layer5 site map (how pages relate and the high-level data flow) rather than site designs, and revert the whitespace-only realignment of the build-variables table that the pre-commit prettier hook introduced. Signed-off-by: Sameer Kumar <sameerkr.dev@gmail.com>
Description
This PR fixes #8235
The "Style Guide" section of CONTRIBUTING.md asked contributors to review a "design doc" hosted on Google Docs. That document has been deleted (HTTP 410), so the link is dead.
This replaces it with the Layer5 Designs Figma file, the same link the issue templates and the 404 page already point contributors to as "Layer5 site designs":
please review the [design doc](https://docs.google.com/document/d/1rvUZy2_.../edit#)please review the [Layer5 site map](https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs) in Figma to understand how the pages of the website relate to each other and the high-level data flow between themNotes for Reviewers
npm run check:contributing-versionspasses.Signed commits
Summary by CodeRabbit