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

automation for code-driven documentation updates #1011

Open
plyr4 opened this issue Oct 2, 2024 · 1 comment
Open

automation for code-driven documentation updates #1011

plyr4 opened this issue Oct 2, 2024 · 1 comment
Labels
feature Indicates a new feature

Comments

@plyr4
Copy link
Contributor

plyr4 commented Oct 2, 2024

Description

this means documentation content that gets updated based on what exists in code.

  • generate API response bodies using Swagger definitions
  • generate CLI reference docs using CLI command/help output
  • generate Plugin docs using things like codeowners

would save us a lot of time
would move things to a centralized source of truth for technical details that dont need extra docs flavoring
would force us to keep swagger + code up to date
might lead into other enhancements like auto generated SDK code and Elm structs

@plyr4 plyr4 added the feature Indicates a new feature label Oct 2, 2024
@wass3r
Copy link
Collaborator

wass3r commented Nov 23, 2024

can you elaborate on "generate Plugin docs using things like codeowners"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Indicates a new feature
Projects
None yet
Development

No branches or pull requests

2 participants