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

Code Generation doesn't generate Markdown #572

Open
sam-heilbron opened this issue Nov 16, 2024 · 0 comments
Open

Code Generation doesn't generate Markdown #572

sam-heilbron opened this issue Nov 16, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@sam-heilbron
Copy link
Contributor

There is a portion of code generation that is responsible for docs generation: https://github.com/solo-io/solo-kit/tree/main/pkg/code-generator/docgen. This is a useful set of generated code, and an example of it is here: https://github.com/solo-io/gloo/blob/main/generate.go#L52.

However, when running:

make generated-code

locally, the generated docs are not modified.

#571 is an example of this. We updated template files, which have an impact on the generated markdown files. However, the PR is safe to merge because the docs are not generated by default.

@sam-heilbron sam-heilbron added the bug Something isn't working label Nov 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant