Skip to content

πŸš€ Add Interactive CLI Docs with DeepGuide #2686

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .dg/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# DeepGuide
.dg/casts/
.dg/svg/
9 changes: 9 additions & 0 deletions .dg/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# DeepGuide Integration

This directory holds configuration and interactive demo assets for [DeepGuide](https://github.com/deepguide-ai/dg).

To add your first demo, run:

```bash
npx @deepguide-ai/dg capture
```
6 changes: 6 additions & 0 deletions .dg/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"version": "0.1.0",
"project": "cli",
"outputDir": ".dg",
"casts": []
}
28 changes: 28 additions & 0 deletions .github/workflows/dg-validate.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: DeepGuide

on:
push:
branches: [ main, master, develop ]
pull_request:
branches: [ main, master ]

jobs:
validate:
name: Validate Demos
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'

- name: Install asciinema
run: |
sudo apt-get update
sudo apt-get install -y asciinema

- name: Validate demos
run: npx @deepguide-ai/dg validate --non-interactive