Automatically generate docs for recipes #297
Merged
Conversation
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
canercidam
approved these changes
Jan 9, 2026
Contributor
canercidam
left a comment
canercidam
left a comment
There was a problem hiding this comment.
Awesome idea, thanks! Do we want to mention docs/recipes in the main README?
Contributor
|
Hmm, actually, just realizing that these diagrams are not rendering in GitHub markdown. @ferranbt Shall we use another format? |
canercidam
approved these changes
Jan 12, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This PR introduces a new
playground generate-docscommand which generates docs under the /docs folder for recipes in markdown file from the Go definitions. There is also a CI check to make sure the docs are always on sync.