You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem or use-case? Please describe.
API reference materials provide the necessary foundation for good documentation. Ideally these reference docs are automatically generated from the code itself.
Describe the solution that you would like.
Use a tool, such as crd-ref-docs, to auto-generate documentation from source code.
Add a separate "Reference" section of the docs for the auto-generated material. This should be separate from the current material.
Describe alternatives you have considered.
Keep the current approach of adding "reference" materials to the existing doc articles. This causes us to overload our doc articles with reference material and "how to" material mixed together.
Anything else?
Much of this recommendation came from LF/CNCF materials:
Is there an existing feature request for this?
Is your feature request related to a problem or use-case? Please describe.
API reference materials provide the necessary foundation for good documentation. Ideally these reference docs are automatically generated from the code itself.
Describe the solution that you would like.
Describe alternatives you have considered.
Keep the current approach of adding "reference" materials to the existing doc articles. This causes us to overload our doc articles with reference material and "how to" material mixed together.
Anything else?
Much of this recommendation came from LF/CNCF materials:
The text was updated successfully, but these errors were encountered: