docs(guides): make subject mapping and component docs SDK-agnostic#361
Conversation
Neutralize OpenTDF-centric framing to "the platform" on pages vendored into the Virtru developer-docs site (rendered for both OpenTDF and Data Harbor), following the balanced approach used in the auth-guides PR. Product/spec names, source links, quickstart references, and the TDF spec itself are left intact. otdfctl/CLI references are out of scope (separate CLI ticket). - subject-mapping-guide: framing prose neutralized - components (key_access, subject_mappings, key_managers): framing prose neutralized Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
|
Warning Review limit reached
Next review available in: 52 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughDocumentation updates replace product-specific “OpenTDF” wording with generalized “platform” terminology across KAS, key management, subject mappings, and the subject mapping guide, including architecture diagrams, troubleshooting guidance, and FAQ text. ChangesPlatform terminology updates
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates several documentation files to replace references to "OpenTDF" or "OpenTDF platform" with "the platform" or "platform" for consistency. A review comment suggests refining the phrasing in the key managers documentation to avoid repetitive use of the word "platform" and improve readability.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/components/policy/keymanagement/key_managers.md (1)
8-8: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winRemove the redundant “of” in the changed sentence.
LanguageTool flags “outside of” on Line 8; use “outside” instead.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/components/policy/keymanagement/key_managers.md` at line 8, Update the sentence in key_managers.md to replace “outside of a key access server or the platform” with “outside a key access server or the platform,” leaving the rest of the key managers explanation unchanged.Source: Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/components/key_access.md`:
- Line 3: Update the documentation sentence near “Key Access Server” to avoid
Vale flagging “TDFs” by rephrasing it as “TDF files,” or add the established TDF
acronym to Vale’s approved vocabulary if that is the project convention.
---
Nitpick comments:
In `@docs/components/policy/keymanagement/key_managers.md`:
- Line 8: Update the sentence in key_managers.md to replace “outside of a key
access server or the platform” with “outside a key access server or the
platform,” leaving the rest of the key managers explanation unchanged.
🪄 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: 23547098-b905-4316-994e-a8b2ee57dc19
📒 Files selected for processing (4)
docs/components/key_access.mddocs/components/policy/keymanagement/key_managers.mddocs/components/policy/subject_mappings.mddocs/guides/subject-mapping-guide.md
- key_access: "TDFs" -> "TDF files" to clear the Vale spelling flag on the edited line - key_managers: reword intro to avoid repeating "the platform" (per CodeRabbit/Gemini) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
|
❌ Surge preview build failed — no preview was deployed. Check the workflow logs for details. Once the build passes, the preview will be at: https://opentdf-docs-pr-361.surge.sh Common cause: If the build failed on vendored YAML validation, run the following locally and commit the result: |
2 participants
Summary
Follow-up to the auth-guides PR (#360). Neutralizes OpenTDF-centric framing prose to "the platform" on the remaining pages that are vendored into the Virtru developer-docs site (
sdks: [opentdf, data-harbor]), so the same source renders correctly on both opentdf.io and secure.virtru.com.Same balanced approach as #360: only framing is generalized. Real product/spec names, GitHub source links, quickstart references, the reference IdP, and the TDF spec/schema itself are left intact.
otdfctl/ "OpenTDF CLI" references are out of scope (tracked under a separate CLI ticket).Changes
docs/guides/subject-mapping-guide.md— 9 framing edits (intro, architecture description, diagram labels, admin/troubleshooting prose, FAQ). Kept: allopentdf/platformsource links, theopentdf-appJSON example, and the Quickstart references.docs/components/— 3 framing edits:key_access.md,policy/subject_mappings.md,policy/keymanagement/key_managers.md.Assessed, no changes needed
docs/spec/— every "OpenTDF" mention names the specification/format itself (spec title, "OpenTDF (Trusted Data Format)", reference implementation, schema paths). No-op, same finding as the SDK reference pages.docs/components/(remainder) — all other mentions are source links,/spec/schema/opentdf/paths, version references, and CLI references (deferred).Testing
npm run build— succeeds (broken-anchor warnings are all pre-existing on untouched lines).npm run check-vendored-yaml— passes.Summary by CodeRabbit