Skip to content

fix(docs): remove broken STYLE_GUIDE.md link and fix docs site URL in README#314

Open
zeemy23 wants to merge 1 commit intomainfrom
fix-readme-broken-link-and-url
Open

fix(docs): remove broken STYLE_GUIDE.md link and fix docs site URL in README#314
zeemy23 wants to merge 1 commit intomainfrom
fix-readme-broken-link-and-url

Conversation

@zeemy23
Copy link
Copy Markdown

@zeemy23 zeemy23 commented May 1, 2026

Summary

Fixes two small issues in README.md:

  1. Broken link removed — The Contributing section referenced [Style Guide](STYLE_GUIDE.md), but STYLE_GUIDE.md does not exist in the repository (returns 404). Removed the dangling reference.

  2. 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 is docs.opentdf.io (confirmed via static/CNAME). Updated both URLs to https://docs.opentdf.io.

What changed

  • Removed the For style guidelines, please refer to our [Style Guide](STYLE_GUIDE.md). line
  • Changed https://opentdf.iohttps://docs.opentdf.io in two places

Test plan

  • Verify the "Live Documentation" link resolves correctly
  • Verify no remaining references to STYLE_GUIDE.md
  • Build passes (npm run build)

Summary by CodeRabbit

  • Documentation
    • Updated documentation links to reflect current resources.
    • Simplified contribution guidelines.

… 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>
@zeemy23 zeemy23 requested review from a team as code owners May 1, 2026 16:33
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 1, 2026

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: 0d489f14-793c-4e28-ab18-bd68226f87b1

📥 Commits

Reviewing files that changed from the base of the PR and between 0d82f34 and a8b2883.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The README.md is updated to change website references from https://opentdf.io to https://docs.opentdf.io across multiple sections, and removes the explicit link to STYLE_GUIDE.md from the Contributing section.

Changes

Cohort / File(s) Summary
Documentation Links Update
README.md
Updated docs URL from opentdf.io to docs.opentdf.io and removed explicit STYLE_GUIDE.md reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • marythought

Poem

🐰 A rabbit hops through docs so bright,
Links now point to URLs right,
From opentdf to docs subdomain,
Clarity flows like morning rain,
Guides refined, documentation's light! ✨

🚥 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 pull request title accurately and specifically summarizes the main changes: removing a broken STYLE_GUIDE.md link and fixing the documentation URL from opentdf.io to docs.opentdf.io.
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-readme-broken-link-and-url

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
Review rate limit: 0/1 reviews remaining, refill in 60 minutes.

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation URL to the correct subdomain and removes a link to a missing style guide. Feedback was provided to update remaining references to style standards to maintain consistency for contributors.

Comment thread README.md
- Review and approval process
- Technical setup for contributors

For style guidelines, please refer to our [Style Guide](STYLE_GUIDE.md).
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.

medium

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.

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.

1 participant