Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Auto-generate API Reference Docs #145

Open
1 task done
adambkaplan opened this issue Feb 17, 2025 · 1 comment
Open
1 task done

[FEATURE] Auto-generate API Reference Docs #145

adambkaplan opened this issue Feb 17, 2025 · 1 comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@adambkaplan
Copy link
Member

Is there an existing feature request for this?

  • I have searched the existing feature requests

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.

  1. Use a tool, such as crd-ref-docs, to auto-generate documentation from source code.
  2. 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:

@adambkaplan adambkaplan added the kind/feature Categorizes issue or PR as related to a new feature. label Feb 17, 2025
@adambkaplan
Copy link
Member Author

Credit to @nate-double-u for pointing me to the sandbox primer and sending me down this path.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
Status: No status
Development

No branches or pull requests

1 participant