-
Notifications
You must be signed in to change notification settings - Fork 1
JP updates to the OpenTDF docs #153
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: docs/update_policy_docs
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @jp-ayyappan, 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 primarily adjusts the build configuration for OpenAPI documentation. The change ensures that the generated documentation is placed within a more structured "reference" directory, improving the organization of the overall documentation site by providing a clearer hierarchy for API-related content. Highlights
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.
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 updates the output directory for the OpenAPI documentation, moving it into a reference subdirectory. The change in src/openapi/preprocessing.ts correctly updates the path. However, this change appears to break a link in docs/reference/index.mdx. I have left a comment detailing the issue and suggesting a fix. Once this is addressed, the change will be a good improvement for the documentation's structure.
Created comprehensive guide covering the relationship between OpenTDF and other TDF specifications including IC-TDF, BASE-TDF, and ZTDF (ACP-240). Includes format comparison tables, migration strategies, and guidance on format selection for different use cases. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
21cb6d9 to
ccf9019
Compare
The nanotdf directory no longer exists in the opentdf/spec repository, causing a 404 error during startup. NanoTDF docs are maintained locally. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
No description provided.