Conversation
- Adds intro paragraph explaining TDF structure and page scope - Imports and displays encrypt options and decrypt options sections - Adds "Inspecting a TDF Without Decrypting" section (Go, Java, TypeScript) - Adds Prerequisites tip linking to SDK Quickstart Closes DSPX-2427 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the TDF documentation, providing developers with comprehensive guidance on encrypting and decrypting data using the Trusted Data Format. It clarifies various configuration options across Go, Java, and TypeScript SDKs and introduces a new section on inspecting TDF metadata without requiring full decryption, making it easier for users to understand and implement TDF functionalities. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request significantly expands the TDF documentation, which is a great improvement. The new content on encrypt and decrypt options, as well as inspecting TDFs, will be very helpful for users. My review focuses on improving the clarity and correctness of the new documentation by pointing out some formatting issues with Docusaurus admonitions and several inconsistencies or errors in the code samples, such as incorrect method capitalization in Java examples and missing imports in Go examples. Addressing these points will make the documentation more polished and easier for developers to use.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ction Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…meter tables Add method signatures, parameter tables, return values, and error descriptions for CreateTDF, LoadTDF, IsValidTdf, BulkDecrypt, and TDF Reader methods. Replace the top-level narrative structure with per-method API reference blocks followed by the existing encrypt and decrypt options detail sections. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…rypt examples - Remove unused client.open() from JavaScript metadata example in decrypt_options.mdx - Add ctx := context.Background() to BulkDecrypt and PrepareBulkDecrypt Go snippets Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Link prose mentions of TDF reader, TDFReader, PolicyObject, and Manifest Object to their respective reference sections - Fix broken anchor #manifest--getmanifest--... → #manifest - Fix HTML entities for List<Type> in PolicyObject table to prevent MDX JSX parse errors Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signature, Parameters, Returns, Errors, Example, and type-reference field headings were ### headings, polluting the TOC and visually competing with method names. Changed to bold text so only method names and TDF Reader sub-methods appear in the page outline. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
HTML entities inside backtick code spans render literally. Real angle brackets inside backticks are safe from MDX JSX parsing. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Both sections previously said "wrap the data encryption key" or "ephemeral session key" without explaining the underlying mechanism. Added plain-language explanations of the DEK wrapping flow and the ephemeral key exchange, and what rsa:2048 means as an identifier. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…oss SDK pages Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
decrypt_options.mdx included a full Reading the Decrypted Payload section (Payload, Unencrypted Metadata, Policy Object, Data Attributes, Manifest) that was already covered by TDF Reader in tdf.mdx. Removing it eliminates 3 duplicate heading anchors on the composed page. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add Quick Start section with SDK initialization and end-to-end encrypt/decrypt example in Go, Java, and JavaScript - Add JavaScript source type table (buffer, stream) to LoadTDF parameters - Replace unhelpful Java IOException table with a plain note - Replace STANAG 5636 assertion example with generic application/json - Add signing key code examples for assertions (Go, Java, JavaScript) - Add KAS link and explanation to KAS Configuration option description - Group KASInfo, PolicyObject, Manifest Object under ## Type Reference to clearly distinguish types from callable methods in the TOC Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Preview: https://opentdf-docs-pr-225.surge.sh/sdks/tdf
Summary
CreateTDF,LoadTDF,IsValidTdf,BulkDecrypt/PrepareBulkDecrypt(Go), and all TDF Reader methodsKASInfo,PolicyObject, andManifest Objectwith field tables — clearly separated from callable methods in the TOCclassification/secret) withclearance/executiveacross all SDK pagestdf.mdx,encrypt_options.mdx,decrypt_options.mdxTest plan
🤖 Generated with Claude Code