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

docs: autogen config pages for each component #16

Open
danielhochman opened this issue Jul 18, 2020 · 0 comments
Open

docs: autogen config pages for each component #16

danielhochman opened this issue Jul 18, 2020 · 0 comments
Labels
area: docs Improvements or additions to documentation type: enhancement New feature or request

Comments

@danielhochman
Copy link
Collaborator

Description

Each component on the components page should link to a detailed page with more information, mainly how to configure it and documentation for all of the fields.

One open question is how we'll know which config object each service uses. We could scrape it based on the imports, but it will be fairly brittle. We may want some way in the clutchdoc or otherwise for a service to declare its config type.

We have some proto documentation capabilities in the docs generator that can list out the object. We'll need to add onto this a bit to scrape comments, etc if we really want to make this effective.

Complexity [S/M/L]: M

@danielhochman danielhochman added area: docs Improvements or additions to documentation type: enhancement New feature or request labels Jul 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Improvements or additions to documentation type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant