Merge pull request pieces-app#587 from jimbobbennett/feat/add-how-to

Adding other Pieces components to the save a snippet how to guide
Bryan-Roe · Oct 30, 2024 · 6c0fe56 · 6c0fe56
2 parents 777f4a8 + 55d514f
commit 6c0fe56
Show file tree

Hide file tree

Showing 65 changed files with 410 additions and 61 deletions.
diff --git a/docs/how-to-guides/save-a-snippet/index.mdx b/docs/how-to-guides/save-a-snippet/index.mdx
diff --git a/docs/how-to-guides/save-a-snippet/media/images/all-context.webp b/docs/how-to-guides/save-a-snippet/media/images/all-context.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/desktop-captured-context-button-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/desktop-captured-context-button-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/desktop-captured-context-button-light.webp b/docs/how-to-guides/save-a-snippet/media/images/desktop-captured-context-button-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/desktop-captured-context-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/desktop-captured-context-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/desktop-captured-context-light.webp b/docs/how-to-guides/save-a-snippet/media/images/desktop-captured-context-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/desktop-snippet-list-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/desktop-snippet-list-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/desktop-snippet-list-light.webp b/docs/how-to-guides/save-a-snippet/media/images/desktop-snippet-list-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/drag-file-to-desktop-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/drag-file-to-desktop-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/drag-file-to-desktop-light.webp b/docs/how-to-guides/save-a-snippet/media/images/drag-file-to-desktop-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/obsidian-find-code-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/obsidian-find-code-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/obsidian-find-code-light.webp b/docs/how-to-guides/save-a-snippet/media/images/obsidian-find-code-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/obsidian-pieces-explorer-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/obsidian-pieces-explorer-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/obsidian-pieces-explorer-light.webp b/docs/how-to-guides/save-a-snippet/media/images/obsidian-pieces-explorer-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/obsidian-save-button-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/obsidian-save-button-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/obsidian-save-button-light.webp b/docs/how-to-guides/save-a-snippet/media/images/obsidian-save-button-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/obsidian-saved-snippet-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/obsidian-saved-snippet-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/obsidian-saved-snippet-light.webp b/docs/how-to-guides/save-a-snippet/media/images/obsidian-saved-snippet-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/pycharm-context-menu-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/pycharm-context-menu-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/pycharm-context-menu-light.webp b/docs/how-to-guides/save-a-snippet/media/images/pycharm-context-menu-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/pycharm-context-menu.webp b/docs/how-to-guides/save-a-snippet/media/images/pycharm-context-menu.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/pycharm-pieces-explorer-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/pycharm-pieces-explorer-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/pycharm-pieces-explorer-light.webp b/docs/how-to-guides/save-a-snippet/media/images/pycharm-pieces-explorer-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/pycharm-saved-snippet-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/pycharm-saved-snippet-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/pycharm-saved-snippet-light.webp b/docs/how-to-guides/save-a-snippet/media/images/pycharm-saved-snippet-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/pycharm-select-code-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/pycharm-select-code-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/pycharm-select-code-light.webp b/docs/how-to-guides/save-a-snippet/media/images/pycharm-select-code-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/python-code.webp b/docs/how-to-guides/save-a-snippet/media/images/python-code.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/save-from-clipboard-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/save-from-clipboard-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/save-from-clipboard-light.webp b/docs/how-to-guides/save-a-snippet/media/images/save-from-clipboard-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/saved-materials-menu-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/saved-materials-menu-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/saved-materials-menu-light.webp b/docs/how-to-guides/save-a-snippet/media/images/saved-materials-menu-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/saved-materials-tab.webp b/docs/how-to-guides/save-a-snippet/media/images/saved-materials-tab.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/saved-snippet-panel.webp b/docs/how-to-guides/save-a-snippet/media/images/saved-snippet-panel.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/view-all-context.webp b/docs/how-to-guides/save-a-snippet/media/images/view-all-context.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vs-context-menu-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/vs-context-menu-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vs-context-menu-light.webp b/docs/how-to-guides/save-a-snippet/media/images/vs-context-menu-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vs-pieces-explorer-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/vs-pieces-explorer-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vs-pieces-explorer-light.webp b/docs/how-to-guides/save-a-snippet/media/images/vs-pieces-explorer-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vs-saved-snippet-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/vs-saved-snippet-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vs-select-code-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/vs-select-code-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vs-select-code-light.webp b/docs/how-to-guides/save-a-snippet/media/images/vs-select-code-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vs-view-pieces-explorer-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/vs-view-pieces-explorer-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vs-view-pieces-explorer-light.webp b/docs/how-to-guides/save-a-snippet/media/images/vs-view-pieces-explorer-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vscode-context-menu-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/vscode-context-menu-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vscode-context-menu-light.webp b/docs/how-to-guides/save-a-snippet/media/images/vscode-context-menu-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vscode-pieces-explorer-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/vscode-pieces-explorer-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vscode-pieces-explorer-light.webp b/docs/how-to-guides/save-a-snippet/media/images/vscode-pieces-explorer-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vscode-saved-snippet-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/vscode-saved-snippet-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vscode-saved-snippet-light.webp b/docs/how-to-guides/save-a-snippet/media/images/vscode-saved-snippet-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vscode-select-code-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/vscode-select-code-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/vscode-select-code-light.webp b/docs/how-to-guides/save-a-snippet/media/images/vscode-select-code-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/web-find-code-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/web-find-code-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/web-find-code-light.webp b/docs/how-to-guides/save-a-snippet/media/images/web-find-code-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/web-pieces-extension-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/web-pieces-extension-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/web-pieces-extension-light.webp b/docs/how-to-guides/save-a-snippet/media/images/web-pieces-extension-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/web-save-button-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/web-save-button-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/web-save-button-light.webp b/docs/how-to-guides/save-a-snippet/media/images/web-save-button-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/web-saved-snippet-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/web-saved-snippet-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/web-saved-snippet-light.webp b/docs/how-to-guides/save-a-snippet/media/images/web-saved-snippet-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/web-snippet-list-dark.webp b/docs/how-to-guides/save-a-snippet/media/images/web-snippet-list-dark.webp
diff --git a/docs/how-to-guides/save-a-snippet/media/images/web-snippet-list-light.webp b/docs/how-to-guides/save-a-snippet/media/images/web-snippet-list-light.webp
diff --git a/docs/how-to-guides/save-a-snippet/resources/helloworld.py b/docs/how-to-guides/save-a-snippet/resources/helloworld.py
@@ -1,2 +1,5 @@
-name = input("What is your name? ")
-print("Hello, " + name + "!")
+def say_hello():
+    name = input("What is your name? ")
+    print("Hello, " + name + "!")
+
+say_hello()
diff --git a/sidebars.ts b/sidebars.ts
@@ -95,6 +95,28 @@ const sidebars: SidebarsConfig = {
         },
       ]
     },
+    {
+      // Guides
+      type: 'category',
+      label: '📚 How-To Guides',
+      items: [
+        {
+          type: 'doc',
+          id: 'how-to-guides/save-a-snippet/index',
+          label: 'Save a Code Snippet Using Pieces'
+        },
+        {
+          type: 'doc',
+          id: 'product-highlights-and-benefits/connecting-to-a-remote-pieces-os-instance',
+          label: 'Connecting VS Code to a Remote Pieces OS Instance',
+        },
+        {
+          type: 'doc',
+          id: 'product-highlights-and-benefits/sync-across-multiple-devices-using-github',
+          label: 'Sync Data Across Devices with GitHub',
+        },
+      ]
+    },
     {
       type: 'category',
       label: '💾 Pieces OS',
@@ -227,28 +249,6 @@ const sidebars: SidebarsConfig = {
         }
       ]
     },
-    {
-      // Guides
-      type: 'category',
-      label: '📚 Guides',
-      items: [
-        {
-          type: 'doc',
-          id: 'how-to-guides/save-a-snippet/index',
-          label: 'Save a Code Snippet Using Pieces Desktop App'
-        },
-        {
-          type: 'doc',
-          id: 'product-highlights-and-benefits/connecting-to-a-remote-pieces-os-instance',
-          label: 'Connecting to a Remote Pieces OS Instance',
-        },
-        {
-          type: 'doc',
-          id: 'product-highlights-and-benefits/sync-across-multiple-devices-using-github',
-          label: 'Sync Data Across Devices with GitHub',
-        },
-      ]
-    },
     {
       type: 'category',
       label: '🌱 Resources',

diff --git a/src/css/custom.css b/src/css/custom.css
@@ -446,3 +446,8 @@ html[data-theme='dark'] .header-github-link:before {
   margin-right: 5px;
   animation: pulse 2s infinite;
 }
+
+[data-theme='light'] img[src$='#gh-dark-mode-only'],
+[data-theme='dark'] img[src$='#gh-light-mode-only'] {
+  display: none;
+}