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] Configuration documentation, finally! Woohoo!! #486

Merged
merged 3 commits into from Sep 1, 2023
Merged

Conversation

manugarg
Copy link
Contributor

@manugarg manugarg commented Sep 1, 2023

  • I've been wanting to do this for so long. \o/
  • Finally we have configuration documentation, automatically generated from the protobufs themselves.
  • Documentation is generated using the new tool I created recently: https://github.com/manugarg/protodoc
  • Moreover we generate the documentation for both the formats: yaml and textpb, and provide a way to switch between the two.

- I've been wanting to do this for so long. \o/
- Finally we have configuration documentation, automatically generated
  from the protobufs themselves.
- Documentation is generated using the new tool I created recently:
  https://github.com/manugarg/protodoc
- Moreover we generate the documentation for both the formats: yaml and
  textpb, and provide a way to switch between the two.
manugarg added a commit that referenced this pull request Sep 1, 2023
Deploy #486 \o/ \o/

Co-authored-by: manugarg <manugarg@users.noreply.github.com>
- Select at least one config language (default: yaml).
@manugarg manugarg merged commit 90f64fc into master Sep 1, 2023
11 checks passed
@manugarg manugarg deleted the config_docs branch September 1, 2023 19:25
@manugarg manugarg added this to the v0.12.9 milestone Sep 2, 2023
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 this pull request may close these issues.

None yet

1 participant