chore(docs): TDF page cleanup — Setup rename, example placement, DEK link by marythought · Pull Request #279 · opentdf/docs

marythought · 2026-04-07T16:16:09Z

Summary

Rename Quick Start to Setup for consistency with other SDK pages
Move usage examples after Parameters (Signature → Parameters → Example → Returns → Errors) for CreateTDF, LoadTDF, IsValidTdf, BulkDecrypt
Link DEK reference to protocol spec on assertions page

Part of #274 (task 2)

preview: https://opentdf-docs-pr-279.surge.sh/sdks/tdf

Test plan

Verify TDF Setup section renders correctly
Verify examples appear after Parameters for all 4 methods
Verify DEK link works

🤖 Generated with Claude Code

Summary by CodeRabbit

Documentation
- Corrected JavaScript code tab labels in documentation examples
- Reordered documentation sidebar navigation sections
- Restructured TDF guide content sections and updated descriptions for improved clarity

coderabbitai · 2026-04-07T16:16:25Z

Warning

Rate limit exceeded

@marythought has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 16 minutes and 51 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 16 minutes and 51 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: 1e3ef143-4cd8-4e48-afc1-ea008e5061c7

📥 Commits

Reviewing files that changed from the base of the PR and between 76903eb and 9287c37.

📒 Files selected for processing (1)

docs/sdks/tdf.mdx

📝 Walkthrough

Walkthrough

Changes standardize JavaScript tab labels across code sample documentation files (changing "TypeScript" to "JavaScript"), reorganize SDK documentation sidebar ordering, and restructure the TDF documentation by relocating Returns/Errors sections and updating introductory content.

Changes

Cohort / File(s)	Summary
Code Sample Tab Label Standardization `code_samples/authorization/get_decision.mdx`, `code_samples/authorization/get_entitlements.mdx`, `code_samples/policy_code/create_attribute.mdx`, `code_samples/policy_code/create_namespace.mdx`, `code_samples/policy_code/create_subject_condition_set.mdx`, `code_samples/policy_code/create_subject_mapping.mdx`, `code_samples/policy_code/list_attributes.mdx`, `code_samples/policy_code/list_namespaces.mdx`, `code_samples/policy_code/list_subject_mapping.mdx`	Updated JavaScript tab labels from "TypeScript" to "JavaScript" for consistency across code samples.
SDK Documentation Sidebar Reordering `docs/sdks/authentication.mdx`, `docs/sdks/authorization.mdx`, `docs/sdks/discovery.mdx`, `docs/sdks/platform-client.mdx`, `docs/sdks/troubleshooting.mdx`, `docs/sdks/quickstart/_category_.json`	Updated `sidebar_position` and `position` frontmatter values to reorganize SDK documentation navigation order.
TDF Documentation Restructuring `docs/sdks/tdf.mdx`	Reorganized documentation structure by relocating Returns/Errors sections after examples, updated section headings (Quick Start → Setup), refined introductory content, and clarified TDF DEK reference linking.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related issues

chore(docs): SDK page cleanup — sidebar order, example placement, JS/TS naming #274: Directly addresses the same objectives—standardizing JS/TS tab naming conventions, reordering SDK sidebar entries, and reorganizing TDF documentation structure.

Possibly related PRs

docs(sdk): expand BulkDecrypt section with options, error handling, and best practices #271: Modifies docs/sdks/tdf.mdx BulkDecrypt documentation, overlapping with this PR's BulkDecrypt section reorganization.
feat(docs): add authentication decision guide and SDK auth reference #250: Updates frontmatter for docs/sdks/authentication.mdx, directly overlapping with this PR's sidebar positioning changes.

Suggested reviewers

eugenioenko
jp-ayyappan

Poem

🐰 Tab labels dancing in a row,
JavaScript shines with a brighter glow,
Sidebars shuffle to find their place,
Documentation's prettier with newfound grace! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The PR title accurately summarizes the main changes: TDF documentation page reorganization including section rename, example reordering, and DEK link addition.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ 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/274-b-tdf-cleanup

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.}

gemini-code-assist

Code Review

This pull request focuses on documentation consistency and structural improvements. Key changes include renaming "TypeScript" tab labels to "JavaScript" across various code samples, reordering sidebar positions for SDK documentation, and restructuring the TDF documentation to move return and error specifications after the code examples. Feedback identifies a terminology error in the Go error documentation and suggests populating an empty JavaScript code block for entitlements to improve documentation completeness.

coderabbitai

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 `@docs/sdks/tdf.mdx`:
- Line 1217: The link target "/spec/protocol" in the sentence "Every assertion
is bound to the TDF's [data encryption key (DEK)](/spec/protocol) by default..."
is broken; locate that exact link text and either replace the href with the
external Trusted Data Format spec URL (https://github.com/opentdf/spec) or
remove the markdown link markup so "data encryption key (DEK)" remains plain
text; ensure the surrounding sentence remains unchanged and that the updated
link points to a valid resource.

🪄 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: a459e92b-61aa-4ab5-8bac-0746609a9d96

📥 Commits

Reviewing files that changed from the base of the PR and between ea5d89a and 76903eb.

📒 Files selected for processing (16)

code_samples/authorization/get_decision.mdx
code_samples/authorization/get_entitlements.mdx
code_samples/policy_code/create_attribute.mdx
code_samples/policy_code/create_namespace.mdx
code_samples/policy_code/create_subject_condition_set.mdx
code_samples/policy_code/create_subject_mapping.mdx
code_samples/policy_code/list_attributes.mdx
code_samples/policy_code/list_namespaces.mdx
code_samples/policy_code/list_subject_mapping.mdx
docs/sdks/authentication.mdx
docs/sdks/authorization.mdx
docs/sdks/discovery.mdx
docs/sdks/platform-client.mdx
docs/sdks/quickstart/_category_.json
docs/sdks/tdf.mdx
docs/sdks/troubleshooting.mdx

github-actions · 2026-04-07T16:20:38Z

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

…link (#274) - Rename Quick Start to Setup for consistency with other SDK pages - Move usage examples after Parameters (before Returns/Errors) for CreateTDF, LoadTDF, IsValidTdf, and BulkDecrypt - Link DEK reference to protocol spec on assertions page Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Gemini review caught that the Go error table referenced Java's `out` parameter instead of Go's `writer`. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

TDF operations use the core SDK client, not the PlatformClient. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

jp-ayyappan

LGTM

marythought requested review from a team as code owners April 7, 2026 16:16

gemini-code-assist Bot reviewed Apr 7, 2026

View reviewed changes

Comment thread docs/sdks/tdf.mdx Outdated

Comment thread code_samples/authorization/get_entitlements.mdx

marythought changed the base branch from main to chore/274-a-sidebar-tab-naming April 7, 2026 16:20

coderabbitai Bot reviewed Apr 7, 2026

View reviewed changes

Comment thread docs/sdks/tdf.mdx

marythought force-pushed the chore/274-b-tdf-cleanup branch from 76903eb to d20adb8 Compare April 7, 2026 16:21

marythought changed the base branch from chore/274-a-sidebar-tab-naming to main April 7, 2026 16:21

marythought force-pushed the chore/274-b-tdf-cleanup branch from d20adb8 to fe46687 Compare April 7, 2026 16:22

fix: correct error table reference from out to generic description

515008f

Gemini review caught that the Go error table referenced Java's `out` parameter instead of Go's `writer`. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

elizabethhealy reviewed Apr 7, 2026

View reviewed changes

Comment thread docs/sdks/tdf.mdx Outdated

marythought and others added 3 commits April 7, 2026 09:47

fix: rephrase Setup intro — examples include client creation

470398d

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

fix: note that all examples require the platform client

0e1da03

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

fix: change "platform client" to "SDK client" in TDF Setup

fa5da13

TDF operations use the core SDK client, not the PlatformClient. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

marythought requested a review from elizabethhealy April 7, 2026 16:50

Merge branch 'main' into chore/274-b-tdf-cleanup

9287c37

marythought enabled auto-merge (squash) April 7, 2026 16:59

jp-ayyappan approved these changes Apr 7, 2026

View reviewed changes

marythought merged commit 930f7d2 into main Apr 7, 2026
9 checks passed

marythought deleted the chore/274-b-tdf-cleanup branch April 7, 2026 20:43

coderabbitai Bot mentioned this pull request Apr 7, 2026

chore(docs): restructure Policy page and extract Obligations #281

Merged

4 tasks

This was referenced Apr 23, 2026

chore(docs): add markdownlint and fix all SDK page violations #306

Draft

feat(docs): document SDK.IsHealthy and link unresolved type references #311

Merged

Navigation Menu

Uh oh!

chore(docs): TDF page cleanup — Setup rename, example placement, DEK link - #279

chore(docs): TDF page cleanup — Setup rename, example placement, DEK link#279
marythought merged 6 commits into
mainfrom
chore/274-b-tdf-cleanup

marythought commented Apr 7, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Apr 7, 2026 •

edited

Loading

Rate limit exceeded

Walkthrough

Changes

Estimated code review effort

Possibly related issues

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

github-actions Bot commented Apr 7, 2026

Uh oh!

Uh oh!

jp-ayyappan left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

marythought commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Estimated code review effort

Possibly related issues

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions Bot commented Apr 7, 2026

Uh oh!

Uh oh!

jp-ayyappan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

marythought commented Apr 7, 2026 •

edited

Loading

coderabbitai Bot commented Apr 7, 2026 •

edited

Loading