Skip to content

Conversation

@S-Saranya1
Copy link
Contributor

@S-Saranya1 S-Saranya1 commented Dec 15, 2025

Add code examples in to the package summary page in Java SDK API Refs guide

Motivation and Context

Enhance the Java SDK API Refs documentation to include code examples.

Modifications

  • Created a script inject_examples.py to parse the example-meta.json, map service names to package directories, generate categorized HTML sections, and inject them into package summary pages before the bottom navigation.

  • Modified release-javadoc.yml to include the new script in the build pipeline, running after javadoc generation to post-process the HTML files with code examples.

Testing

  • Ran the inject_examples.py script locally
  • Generated javadoc documentation for test services
  • Opened the package-summary.html files in browser and verified code examples sections are properly displayed
  • Confirmed examples are organized by categories and links work correctly

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist

  • I have read the CONTRIBUTING document
  • Local run of mvn install succeeds
  • My code follows the code style of this project
  • My change requires a change to the Javadoc documentation
  • I have updated the Javadoc documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed
  • I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
  • My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

  • I confirm that this pull request can be released under the Apache 2 license

@S-Saranya1 S-Saranya1 requested a review from a team as a code owner December 15, 2025 22:41
@sonarqubecloud
Copy link

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