-
Notifications
You must be signed in to change notification settings - Fork 8
🚀 Add Interactive CLI Docs with DeepGuide #167
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
Open
taowox
wants to merge
1
commit into
nanoapi-io:main
from
taowox:docs/cli-documentation-1751982854427
Open
🚀 Add Interactive CLI Docs with DeepGuide #167
taowox
wants to merge
1
commit into
nanoapi-io:main
from
taowox:docs/cli-documentation-1751982854427
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
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Hi there! 👋
I noticed napi is an actively maintained CLI tool and wanted to help make your documentation even better!
This PR sets up DeepGuide, a tool for recording and validating interactive terminal demos right in your README (with optional CI validation).
What's in this PR
.dg/directory with initial config.How to add your first interactive demo
After merging this PR, simply run:
Copy the generated markdown to README or other docs as you like. Then commit the changes.
Your repo will be ready for rich, interactive terminal docs!
Why use DeepGuide CLI?
📽️ Easily show live, copy-pasteable usage with animated/interactive demos
🚫 No more GIFs or stale code blocks
🟢 Keep demos up to date (self-testing with CI validation)
If you're not interested, feel free to close. Thanks for your work! 🙏