nacos-java-sdk-doc

Syncing Nacos Java SDK documentation involves comparing Java Client interfaces against usage.md to identify new APIs and overloads, then updating the docs while preserving existing descriptions and examples. It ensures the SDK documentation matches the actual Java interfaces.

Comparing Java interfaces with usage.md keeps SDK docs current by detecting NEW APIs, NEW OVERLOADS, and REMOVED OVERLOADS from the Nacos Java API source. It generates a changelog-style report to guide manual updates and prevent outdated documentation.

Yes, you can detect removed overloads and mark deprecated signatures in Nacos Java SDK docs. The comparison process identifies removed overloads against the Nacos Java API source to prevent outdated documentation from persisting in the next-version usage.md.

The best way to update Nacos Java SDK docs for the next release is running a comparison script against the Nacos repository's api/src/main/java and the next-version docs at src/content/docs/next. This produces a change plan highlighting additions and removals.

Yes, you need access to the Nacos repository's api/src/main/java directory and the next-version docs located at src/content/docs/next. These paths are required to compare the actual Java interfaces with the usage.md documentation.

Yes, Nacos Java SDK documentation sync supports both English and Chinese next-version docs. It aligns the usage documentation with actual Java interfaces for both language versions under the src/content/docs/next directory structure.