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

Add autogenerated configuration docs #2627

Closed
ThomasLaPiana opened this issue Feb 16, 2023 · 0 comments · Fixed by #2694
Closed

Add autogenerated configuration docs #2627

ThomasLaPiana opened this issue Feb 16, 2023 · 0 comments · Fixed by #2694
Assignees

Comments

@ThomasLaPiana
Copy link
Contributor

Is your feature request related to a specific problem?

With the merger of #2613 we'll have all relevant metadata we need within source code to produce exhaustive documentation for our configuration reference.

Describe the solution you'd like

The inclusion of autogenerated configuration documentation included as part of the docs site, which docs.ethyca.com can point to.

Additional context

Configuration docs get out of sync more than anything I would wager, so this is important for usability. Although it might feel weird to pull docs out of the new docs site and into the "legacy" site, it makes sense in this case given that we have no low-friction way to autogenerate docs for the new docs site. Note that we still use the old docs site for hosting the autogenerated API and CLI documentation.

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

Successfully merging a pull request may close this issue.

1 participant