feat(docs): expand TDF documentation (DSPX-2427)#203
feat(docs): expand TDF documentation (DSPX-2427)#203marythought wants to merge 17 commits intomainfrom
Conversation
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 dramatically enhances the OpenTDF SDK documentation by transforming a basic TDF guide into a detailed resource. It aims to provide developers with a deeper understanding of TDF encryption and decryption, covering conceptual foundations, practical implementation choices, and essential operational considerations like ABAC, error handling, and best practices. The update ensures that users have comprehensive information to effectively integrate and troubleshoot TDF within their applications. 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
|
![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 significantly expands the TDF documentation, transforming it from a minimal stub into a comprehensive guide. The new content includes a conceptual overview, guidance on choosing between zTDF and the full TDF format, a process flow diagram, and detailed sections on ABAC usage, decryption patterns, error handling, and best practices. The changes are well-structured and clear. I have identified a couple of potential broken links to other documents or code samples.
marythought
changed the title
|
|
||
| | Operation | Java | TypeScript | | ||
| | --- | --- | --- | | ||
| | Encrypt | `createTDF` | `createZTDF` | |
There was a problem hiding this comment.
Is there really a createZTDF function in OpenTDF? We should rename it. Open cannot create compliant ZTDFs
As a rule; OpenTDF platform does not natively create ZTDFs as outlined here that is a USP of DSP.
Also the DSP SDKs allow creation of ZTDF using a shared_services
|
|
||
| ```mermaid | ||
| flowchart TB | ||
| A["1. Plaintext input"] --> B["2. Create TDF or zTDF"] |
There was a problem hiding this comment.
| A["1. Plaintext input"] --> B["2. Create TDF or zTDF"] | |
| A["1. Plaintext input"] --> B["2. Create TDF"] |
| 2. Attribute value set (policy scope). | ||
| 3. Wrapping/encapsulation algorithm choice where supported. | ||
| 4. Data handling model: in-memory vs stream/file. | ||
| 5. Expected interoperability target (`zTDF` profile vs full container exchange). |
There was a problem hiding this comment.
Again, if there are internal references to zTDF; we should scrub
2 participants
Summary
docs/sdks/tdf.mdxfrom a minimal stub into a full TDF guidezTDFvs full TDF), and flow diagramPreview