Skip to content

Fix URL in README for OpenTDF documentation#261

Merged
eugenioenko merged 2 commits intomainfrom
eugenioenko-patch-1
Mar 26, 2026
Merged

Fix URL in README for OpenTDF documentation#261
eugenioenko merged 2 commits intomainfrom
eugenioenko-patch-1

Conversation

@eugenioenko
Copy link
Copy Markdown
Contributor

@eugenioenko eugenioenko commented Mar 26, 2026

Updated the link to the OpenTDF documentation website.

Summary by CodeRabbit

  • Documentation
    • Updated documentation site URLs across the repository (README, site configuration, and documentation/policy pages) to the current documentation domain.
    • No functional, behavioral, or content changes beyond link targets; commands and examples remain the same.

Updated the link to the OpenTDF documentation website.
@eugenioenko eugenioenko requested review from a team as code owners March 26, 2026 18:06
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 26, 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: d902eb3e-ea53-4c66-9320-d1d79e54e3c0

📥 Commits

Reviewing files that changed from the base of the PR and between 0ca9f60 and 4bd6527.

📒 Files selected for processing (6)
  • README.md
  • docs/sdks/troubleshooting.mdx
  • docusaurus.config.ts
  • src/pages/cookie-policy.mdx
  • src/pages/privacy-policy.mdx
  • src/pages/terms-of-service.mdx
✅ Files skipped from review due to trivial changes (6)
  • src/pages/cookie-policy.mdx
  • src/pages/privacy-policy.mdx
  • src/pages/terms-of-service.mdx
  • docs/sdks/troubleshooting.mdx
  • README.md
  • docusaurus.config.ts

📝 Walkthrough

Walkthrough

Replaced references to https://docs.opentdf.io with https://opentdf.io across documentation files and the Docusaurus site url; no functional code or exported/public API changes.

Changes

Cohort / File(s) Summary
Site config
docusaurus.config.ts
Updated site url from https://docs.opentdf.io to https://opentdf.io. No other config or exports changed.
Top-level README
README.md
Updated repository/documentation links to https://opentdf.io.
SDK docs / troubleshooting
docs/sdks/troubleshooting.mdx
Updated troubleshooting reference link to https://opentdf.io.
Policy pages (MDX)
src/pages/cookie-policy.mdx, src/pages/privacy-policy.mdx, src/pages/terms-of-service.mdx
Replaced site/documentation URL references with https://opentdf.io; no substantive content changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • elizabethhealy

Poem

🐰 I hopped through links both near and far,
Swapped a subdomain with a brighter star.
A tiny nibble, a quick tidy spin,
Now paths lead home — come hop right in! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title states 'Fix URL in README' but the changeset updates URLs across 6 files (README.md, docs/sdks/troubleshooting.mdx, docusaurus.config.ts, src/pages/cookie-policy.mdx, src/pages/privacy-policy.mdx, and src/pages/terms-of-service.mdx), not just the README. Update the title to reflect the broader scope, such as 'Update OpenTDF documentation URLs across repository' or 'Update docs.opentdf.io references to opentdf.io'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch eugenioenko-patch-1

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 7: README.md contains inconsistent documentation URLs: the top uses
https://opentdf.io but the "Quick Links" section still points to
https://docs.opentdf.io. Locate the "Quick Links" block (the link text or URL
string 'https://docs.opentdf.io') and update it to the canonical URL used
earlier (https://opentdf.io) so both links match; verify there are no other
remaining occurrences of 'https://docs.opentdf.io' in README.md and replace them
accordingly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 14829caa-466c-4cf2-9721-4d466ba19226

📥 Commits

Reviewing files that changed from the base of the PR and between c7a2653 and 27ff78c.

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

Comment thread README.md
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 website URL in the README.md file. I have no further feedback to provide as the review comment regarding the 'Quick Links' section did not include a specific code suggestion.

Comment thread README.md
@eugenioenko eugenioenko force-pushed the eugenioenko-patch-1 branch from 0ca9f60 to bff9a86 Compare March 26, 2026 18:15
@eugenioenko eugenioenko force-pushed the eugenioenko-patch-1 branch from bff9a86 to 4bd6527 Compare March 26, 2026 18:16
@eugenioenko eugenioenko merged commit aa842a1 into main Mar 26, 2026
9 of 10 checks passed
@eugenioenko eugenioenko deleted the eugenioenko-patch-1 branch March 26, 2026 22:54
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