Enhance project approachability with embedded CLI demo (SVG) - #7
Open
taowox wants to merge 1 commit into
Open
Conversation
Adds DeepGuide scaffold files to enable interactive terminal demonstrations: - Configuration setup (.dg/config.json) - CI validation workflow - Documentation updates - Git ignore patterns for demo assets No source code changes - purely additive setup for future demos.
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.
Hello!
I’ve been exploring your CLI project and wanted to help make it easier for users to understand and use. This PR sets up DeepGuide, a tool for recording interactive terminal demos directly in your README.
What this PR does
Adds a
.dg/config directory and GitHub Actions workflow to your repo for demo recording and CI validation.No changes to your CLI code itself, only prepares your repo to capture demos.
Next steps for you
After merging, DeepGuide is installed and configured. You can start recording demos by running:
npx @deepguide-ai/dg doctornpx @deepguide-ai/dg captureThis generates interactive SVG demos that you can embed in your README or documentation. Commit these changes to update your docs with live, interactive examples.
Why use DeepGuide CLI?
Make your CLI usage easier to follow with interactive, up-to-date demos.
Avoid stale GIFs or static code blocks.
Automatically validate demos in CI to keep docs accurate.