fix(docs): remove broken STYLE_GUIDE.md link and fix docs site URL in README#314
fix(docs): remove broken STYLE_GUIDE.md link and fix docs site URL in README#314
Conversation
… README - Remove reference to nonexistent STYLE_GUIDE.md (404) - Fix "Live Documentation" URL from https://opentdf.io to https://docs.opentdf.io to match the CNAME and actual site domain - Fix "About This Repository" URL to also use https://docs.opentdf.io Co-authored-by: CoopAgent <coopagent@users.noreply.github.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe README.md is updated to change website references from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
| - Review and approval process | ||
| - Technical setup for contributors | ||
|
|
||
| For style guidelines, please refer to our [Style Guide](STYLE_GUIDE.md). |
There was a problem hiding this comment.
The removal of the STYLE_GUIDE.md link is correct as the file is missing. However, the list item above (line 32) still references "Style and formatting standards". If these standards are now primarily covered by the Vale configuration or the upstream contributing guide, it would be beneficial to update the list or add a brief mention of where these standards can now be found to avoid ambiguity for new contributors.
Summary
Fixes two small issues in
README.md:Broken link removed — The Contributing section referenced
[Style Guide](STYLE_GUIDE.md), butSTYLE_GUIDE.mddoes not exist in the repository (returns 404). Removed the dangling reference.Documentation URL corrected — The "Live Documentation" quick link and the "About This Repository" link both pointed to
https://opentdf.io, but the actual documentation site domain isdocs.opentdf.io(confirmed viastatic/CNAME). Updated both URLs tohttps://docs.opentdf.io.What changed
For style guidelines, please refer to our [Style Guide](STYLE_GUIDE.md).linehttps://opentdf.io→https://docs.opentdf.ioin two placesTest plan
STYLE_GUIDE.mdnpm run build)Summary by CodeRabbit