add walkthrough

microsoft · Jun 18, 2024 · 3ba9131 · 3ba9131
1 parent 7dc0fd5
commit 3ba9131
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 3 deletions.
diff --git a/docs/src/assets/vscode-notebook.png b/docs/src/assets/vscode-notebook.png
diff --git a/docs/src/content/docs/reference/scripts/notebook.mdx b/docs/src/content/docs/reference/scripts/notebook.mdx
@@ -1,11 +1,11 @@
 ---
-title: Notebook (experimental)
+title: Notebook
 sidebar:
   order: 100
 description: Explore the features of the Markdown Notebook for authoring
   documentation with script snippets and inline results.
 keywords: Markdown Notebook, documentation authoring, script snippets, inline
-  results, experimental features
+  results
 genaiscript:
   files: src/samples/markdown.md
   model: openai:gpt-3.5-turbo
@@ -16,6 +16,8 @@ import { Steps } from "@astrojs/starlight/components"
 
 The GenAISCript Markdown Notebook is currently used to author the GenAIScript documentation. 
 
+![Notebook screenshpt](../../../../assets/vscode-notebook.png)
+
 It allows to run script snippets and inline the result in the markdown just like this:
 
 ```js system="false" user="true" wrap

diff --git a/packages/vscode/media/tutorial-start.png b/packages/vscode/media/tutorial-start.png
diff --git a/packages/vscode/package.json b/packages/vscode/package.json
@@ -56,9 +56,31 @@
         "./genaiscript.cjs",
         "./icon-light.svg",
         "./icon-dark.svg",
-        "./tutoria.md"
+        "./tutoria.md",
+        "./media/**"
     ],
     "contributes": {
+        "walkthroughs": [
+            {
+                "id": "genaiscript.tutorial",
+                "title": "GenAI scripting with GenAIScript",
+                "description": "Use GenAIScript to create LLM-powered scripts.",
+                "steps": [
+                    {
+                        "id": "genaiscript.tutorial.start",
+                        "title": "Start Tutorial",
+                        "description": "Welcome to the GenAIScript tutorial!\nIn this tutorial, you'll learn how to create LLM-powered scripts using JavaScript.\nOpen the command palette and select **GenAIScript: Create Mardown Notebook** to get started.",
+                        "media": {
+                            "image": "media/tutorial-start.png",
+                            "altText": ""
+                        },
+                        "completionEvents": [
+                            "onCommand:genaiscript.notebook.create"
+                        ]
+                    }
+                ]
+            }
+        ],
         "notebooks": [
             {
                 "type": "genaiscript",