Skip to content

chore(docs): genericize OpenTDF product name in SDK docs#288

Merged
marythought merged 1 commit intomainfrom
chore/genericize-sdk-docs-product-name
Apr 10, 2026
Merged

chore(docs): genericize OpenTDF product name in SDK docs#288
marythought merged 1 commit intomainfrom
chore/genericize-sdk-docs-product-name

Conversation

@marythought
Copy link
Copy Markdown
Contributor

@marythought marythought commented Apr 9, 2026

Summary

  • Removes "OpenTDF" branding from prose in SDK pages (authentication.mdx, authorization.mdx, policy.mdx) so they read naturally when imported into the Data Security Platform docs
  • Package names, import paths, code examples, and example data (e.g., opentdf.io namespaces) are unchanged
  • Quickstart, index, and troubleshooting pages are excluded (not imported into DSP docs)

Test plan

  • Verify docs site builds cleanly (npm run build)
  • Spot-check the three changed pages render correctly
  • Confirm no broken links or missing content

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Refined SDK documentation wording for clarity and consistency across Authentication, Authorization, and Policy guides.
    • Simplified introductory phrases by removing redundant branding qualifiers.
    • Corrected phrasing in the Token Exchange explanation and other sentences for improved grammar and readability.
    • Documentation-only edits; no API, parameters, or code changes.

@marythought marythought requested review from a team as code owners April 9, 2026 19:41
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 9, 2026

Warning

Rate limit exceeded

@marythought has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 13 minutes and 46 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 13 minutes and 46 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1dc889d1-8c76-4b82-b484-ef01f57f6e0b

📥 Commits

Reviewing files that changed from the base of the PR and between 60e42ca and e318b7e.

📒 Files selected for processing (3)
  • docs/sdks/authentication.mdx
  • docs/sdks/authorization.mdx
  • docs/sdks/policy.mdx
📝 Walkthrough

Walkthrough

Minor wording and grammatical edits to three SDK documentation pages: removed redundant "OpenTDF" branding and fixed phrasing; no code, API, control flow, or exported entities changed.

Changes

Cohort / File(s) Summary
Docs: SDK wording updates
docs/sdks/authentication.mdx, docs/sdks/authorization.mdx, docs/sdks/policy.mdx
Adjusted introductory wording to remove redundant "OpenTDF" references and corrected small grammatical phrasing; documentation-only changes, no functional edits.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • opentdf/docs#282: Touches docs/sdks/authorization.mdx and restructures that page — likely overlaps with the authorization wording change.
  • opentdf/docs#279: Overlaps edits to docs/sdks/authentication.mdx and docs/sdks/authorization.mdx — related documentation adjustments.

Suggested reviewers

  • elizabethhealy
  • jp-ayyappan

Poem

🐇 I nibbled words to make them light,

Trimmed "OpenTDF" out of sight,
Sent phrases hopping, tidy, clear —
A soft rewrite, then carrot cheer! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore(docs): genericize OpenTDF product name in SDK docs' clearly and accurately describes the main change: removing OpenTDF branding references from three SDK documentation files.
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 unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/genericize-sdk-docs-product-name

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

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 across several SDK pages (authentication.mdx, authorization.mdx, and policy.mdx) to remove redundant references to 'OpenTDF' in favor of more concise language. I have no further feedback to provide.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 9, 2026

📄 Preview deployed to https://opentdf-docs-pr-288.surge.sh

@marythought marythought force-pushed the chore/genericize-sdk-docs-product-name branch from 9c80f8c to 60e42ca Compare April 10, 2026 20:11
@marythought marythought force-pushed the chore/genericize-sdk-docs-product-name branch from 60e42ca to e50ef52 Compare April 10, 2026 21:20
Remove "OpenTDF" branding from SDK prose so these pages read
naturally when imported into the Data Security Platform docs.
Package names, imports, and code examples are unchanged.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@marythought marythought force-pushed the chore/genericize-sdk-docs-product-name branch from e50ef52 to e318b7e Compare April 10, 2026 21:27
@marythought marythought merged commit 248646b into main Apr 10, 2026
9 checks passed
@marythought marythought deleted the chore/genericize-sdk-docs-product-name branch April 10, 2026 21:27
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