From da3feef40102e909f37485f8f5ae97589d319c83 Mon Sep 17 00:00:00 2001 From: taowox <137257017+taowox@users.noreply.github.com> Date: Tue, 8 Jul 2025 13:02:44 +0000 Subject: [PATCH] feat: add DeepGuide configuration for interactive CLI demos 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. --- .dg/.gitignore | 3 +++ .dg/README.md | 9 +++++++++ .dg/config.json | 6 ++++++ .github/workflows/dg-validate.yml | 28 ++++++++++++++++++++++++++++ 4 files changed, 46 insertions(+) create mode 100644 .dg/.gitignore create mode 100644 .dg/README.md create mode 100644 .dg/config.json create mode 100644 .github/workflows/dg-validate.yml diff --git a/.dg/.gitignore b/.dg/.gitignore new file mode 100644 index 000000000..1fc54aab2 --- /dev/null +++ b/.dg/.gitignore @@ -0,0 +1,3 @@ +# DeepGuide +.dg/casts/ +.dg/svg/ diff --git a/.dg/README.md b/.dg/README.md new file mode 100644 index 000000000..0b610d8b3 --- /dev/null +++ b/.dg/README.md @@ -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 +``` diff --git a/.dg/config.json b/.dg/config.json new file mode 100644 index 000000000..4f2d835ff --- /dev/null +++ b/.dg/config.json @@ -0,0 +1,6 @@ +{ + "version": "0.1.0", + "project": "cli", + "outputDir": ".dg", + "casts": [] +} \ No newline at end of file diff --git a/.github/workflows/dg-validate.yml b/.github/workflows/dg-validate.yml new file mode 100644 index 000000000..d4452f5d1 --- /dev/null +++ b/.github/workflows/dg-validate.yml @@ -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