Skip to content

fix(docs): fix java sdk documentation#156

Merged
cshamrick merged 4 commits into
mainfrom
update-java-sdk-docs
Nov 21, 2025
Merged

fix(docs): fix java sdk documentation#156
cshamrick merged 4 commits into
mainfrom
update-java-sdk-docs

Conversation

@cshamrick
Copy link
Copy Markdown
Contributor

Key changes include:

  • Remote Content Integration: The docusaurus-plugin-remote-content is now used to fetch Java SDK examples directly from the opentdf/java-sdk repository. This ensures that the documentation always reflects the latest version of the SDK.
  • Dynamic Versioning: The Java SDK version is now managed as a custom field (javaSdkVersion) in docusaurus.config.ts and dynamically inserted into the documentation. This simplifies future version updates.
  • Code Sample Refactoring: Existing Java code samples have been refactored to use the new remote content, improving maintainability and reducing code duplication.

Signed-off-by: Scott Hamrick <2623452+cshamrick@users.noreply.github.com>
Signed-off-by: Scott Hamrick <2623452+cshamrick@users.noreply.github.com>
@cshamrick cshamrick marked this pull request as ready for review November 20, 2025 21:22
@cshamrick cshamrick requested a review from a team as a code owner November 20, 2025 21:22
Copy link
Copy Markdown
Member

@dmihalcik-virtru dmihalcik-virtru left a comment

Choose a reason for hiding this comment

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

Suggestion: Mark the imported files as generated with a .gitattributes file (see the one in platform), for reviewer awareness.

Comment thread docusaurus.config.ts
Signed-off-by: Scott Hamrick <2623452+cshamrick@users.noreply.github.com>
@cshamrick
Copy link
Copy Markdown
Contributor Author

Suggestion: Mark the imported files as generated with a .gitattributes file (see the one in platform), for reviewer awareness.

Done!

@cshamrick cshamrick enabled auto-merge (squash) November 21, 2025 16:11
Comment thread .gitattributes Outdated
@cshamrick cshamrick merged commit 9f7170a into main Nov 21, 2025
3 checks passed
@cshamrick cshamrick deleted the update-java-sdk-docs branch November 21, 2025 16:23
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.

3 participants