docs: Add examples guide with structured overview and navigation - #173
Open
buerbaumer wants to merge 2 commits into
Open
docs: Add examples guide with structured overview and navigation#173buerbaumer wants to merge 2 commits into
buerbaumer wants to merge 2 commits into
Conversation
This guide provides an overview of examples and instructions for using BoltzGen, including validation and generation steps.
Added a reference to the examples guide for better navigation.
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
1 participant
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.
Summary
This PR adds a new
EXAMPLES_GUIDE.mdfile with:boltzgen checkbefore runningThe existing README.md is preserved with only a single line added linking to the new guide.
Motivation
Guide new users to find the right example among the 23 available options. This guide provides quick navigation by category and skill level.