xiaobaicai66695 commented on issue #3598: URL: https://github.com/apache/dubbo-go/issues/3598#issuecomment-5201962707
Hi, issue #3598 currently only has a title and does not include detailed requirements or acceptance criteria. To avoid a scope mismatch, could you please clarify the following points? Does “improve the Dubbo-Go SDK documentation” mean updating the English and Chinese READMEs in this repository, or updating the documentation in the Dubbo website repository? Which SDK topics should be covered: installation, Proto definitions, Go/Triple code generation, server and client examples, configuration, or only OpenAPI-related usage? Does “OpenAPI tooling” refer to:the build-time protoc-gen-triple-openapi generator; the runtime Triple OpenAPI, Swagger UI, and Redoc support; or both? Is a complete runnable example required? Should automated tests or command-level documentation verification also be included? Should the English and Chinese documentation be updated together? Is the target release 3.3.3? If there are no additional requirements, I propose the following scope: Improve the SDK quick-start entry points in the root English and Chinese READMEs. Expand the English and Chinese protoc-gen-triple-openapi getting-started documentation. Provide a complete workflow for generating *.pb.go, *.triple.go, and OpenAPI YAML/JSON files from a .proto definition. Explain the difference between the build-time OpenAPI generator and runtime OpenAPI/Swagger UI/Redoc support. Add output verification, version requirements, and troubleshooting guidance. Execute and verify the documented commands and provide the validation results. Would this scope meet the expected requirements? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
