Generate API and Helm reference docs - #167
Merged
Merged
Conversation
Signed-off-by: Art Berger <art.berger@solo.io>
Signed-off-by: Art Berger <art.berger@solo.io>
Signed-off-by: Art Berger <art.berger@solo.io>
Signed-off-by: Art Berger <art.berger@solo.io>
Signed-off-by: Art Berger <art.berger@solo.io>
see slack: https://solo-io-corp.slack.com/archives/C0882QZ3RB6/p1755249644132989 Signed-off-by: Art Berger <art.berger@solo.io>
Signed-off-by: Art Berger <art.berger@solo.io>
Signed-off-by: Art Berger <art.berger@solo.io>
Signed-off-by: Art Berger <art.berger@solo.io>
artberger
commented
Aug 15, 2025
| "react-markdown": "^10.1.0", | ||
| "rehype-unwrap-images": "^1.0.0", | ||
| "remark-frontmatter": "^5.0.0", | ||
| "remark-gfm": "^4.0.1", |
Collaborator
Author
There was a problem hiding this comment.
This is the Github formatted markdown renderer so that tables in markdown that the API/Helm generates can be rendered on the site. Before it was just passing in raw table content like:
| Field | Description | | --- | | --- | | Lorem ipsum | dolor sit amet |
artberger
commented
Aug 15, 2025
| @@ -0,0 +1,210 @@ | |||
| name: Update Reference Documentation | |||
Collaborator
Author
There was a problem hiding this comment.
similar to the workflow that we have in kgateway
Rachael-Graham
approved these changes
Aug 15, 2025
EItanya
approved these changes
Aug 15, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.