[Docs]: Automated documentation - Githubissues

cloudnative-pg / cnpg-i

CloudNativePG Interface (CNPG-I)

Apache License 2.0

26 stars 4 forks source link

[Docs]: Automated documentation #22

Closed gbartolini closed 7 months ago

gbartolini commented 9 months ago

Is there an existing issue already for your request/idea?

[X] I have searched for an existing issue, and could not find anything. I believe this is a new documentation enhancement to be evaluated.

What problem in the existing documentation this issue aims to solve?

We need an automated way to generate the documentation of the API.

Describe what additions need to be done to the documentation

Use https://github.com/pseudomuto/protoc-gen-doc

Describe what pages need to change in the documentation, if any

No response

Describe what pages need to be removed from the documentation, if any

No response

Additional context

No response

Backport?

N/A

Code of Conduct

[X] I agree to follow this project's Code of Conduct

fcanovai commented 7 months ago

Done in https://github.com/cloudnative-pg/cnpg-i/pull/31