Skip to content

Conversation

@b-long
Copy link
Owner

@b-long b-long commented Sep 16, 2025

fix: improve docs

@b-long b-long requested a review from Copilot September 16, 2025 00:55
Copy link
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.

Summary of Changes

Hello @b-long, 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 improves the documentation for Connect RPC within the OpenTDF Python SDK. It consolidates information from multiple older documents into a single, comprehensive guide, making it easier for developers to understand, use, and migrate to Connect RPC. The change aims to provide a clearer and more up-to-date resource for working with RPC in the SDK.

Highlights

  • Consolidated Connect RPC Documentation: A new comprehensive guide, docs/CONNECT_RPC.md, has been added to detail the Connect RPC implementation in the OpenTDF Python SDK. This document covers its overview, architecture, usage, regeneration steps, benefits over gRPC, migration, testing, error handling, and performance considerations.
  • Removed Redundant Documentation: The previous docs/CONNECT_RPC_MIGRATION.md and docs/PROTOBUF_SETUP.md files have been removed. Their content has either been superseded by the new CONNECT_RPC.md or deemed no longer necessary, streamlining the project's documentation.
  • Updated Script References: The otdf-python-proto/scripts/build_connect_proto.sh script has been updated to reference the new CONNECT_RPC_SETUP.md (likely referring to the newly added CONNECT_RPC.md) for further information, ensuring consistency with the updated documentation structure.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR improves documentation by updating references, removing outdated files, and organizing Connect RPC documentation. The changes primarily focus on documentation hygiene and structure.

  • Removes comprehensive migration and setup documentation files that are no longer needed
  • Updates documentation references to point to the correct files
  • Simplifies the GitHub workflow trigger configuration

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
otdf-python-proto/scripts/build_connect_proto.sh Updates documentation reference from MIGRATION to SETUP
docs/PROTOBUF_SETUP.md Removes outdated protobuf setup documentation
docs/CONNECT_RPC_MIGRATION.md Removes comprehensive migration guide documentation
docs/CONNECT_RPC.md Adds new streamlined Connect RPC documentation
.github/workflows/build-python.yaml Removes specific branch trigger from workflow

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@b-long
Copy link
Owner Author

b-long commented Sep 16, 2025

/gemini review

Copy link
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 aims to improve the documentation by consolidating information about Connect RPC into a new CONNECT_RPC.md file and removing older, more detailed files. The changes are a good step towards simplification. However, I've found a couple of issues: a broken reference in a build script and a significantly incorrect code example in the new documentation. Addressing these will ensure the documentation is accurate and helpful for developers.

Copy link
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 refactors the documentation for Connect RPC, consolidating information from CONNECT_RPC_MIGRATION.md and PROTOBUF_SETUP.md into a new, comprehensive CONNECT_RPC.md file. The changes are a good improvement to the project's documentation. I've found a couple of minor issues: an incorrect URL in a testing example within the new documentation, and a broken file reference in a helper script. Addressing these will further improve the quality and accuracy of the documentation and developer tooling.

@b-long
Copy link
Owner Author

b-long commented Sep 17, 2025

/gemini review

Copy link
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 improves the documentation by consolidating information about Connect RPC into a new docs/CONNECT_RPC.md file and removing older, redundant documents. The changes also update links and code examples in other files to reflect this restructuring.

My review focuses on improving the clarity and correctness of the new documentation. I've suggested several enhancements to the code examples in docs/CONNECT_RPC.md to make them more complete and easier to understand. I also found and suggested fixes for a broken link in otdf-python-proto/README.md and an ambiguous file path in a script's output message. Overall, these are good improvements to the project's documentation.

)

client = kas_connect.KeyAccessServiceClient(base_url="https://example.com")
# Test client calls...
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The comment # Test client calls... is not very helpful. It would be better to show a complete example with a client call and an assertion to demonstrate how to test the client.

Suggested change
# Test client calls...
# Make a request and assert the response
request = kas_pb2.RewrapRequest()
response = client.rewrap(request)
assert response.entity_wrapped_key == b'some-unwrapped-key'

b-long and others added 4 commits September 17, 2025 07:58
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@b-long b-long merged commit 49aa4ae into main Sep 17, 2025
9 checks passed
@b-long b-long deleted the chore/improve-docs branch September 17, 2025 12:09
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