From 533bb6b3052b4f776b5c5358459d771d8b02b493 Mon Sep 17 00:00:00 2001 From: Jim Bennett Date: Tue, 20 Aug 2024 17:35:56 -0700 Subject: [PATCH 1/8] Fixing a couple of spelling mistakes --- docs/extensions-plugins/cli/quickstart.mdx | 2 +- docs/extensions-plugins/raycast/troubleshooting.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/extensions-plugins/cli/quickstart.mdx b/docs/extensions-plugins/cli/quickstart.mdx index 29fd9d3bb..4bdd3d4c4 100644 --- a/docs/extensions-plugins/cli/quickstart.mdx +++ b/docs/extensions-plugins/cli/quickstart.mdx @@ -12,7 +12,7 @@ In this tutorial, you'll learn how to set up and start using the Pieces CLI. We' Date: Wed, 21 Aug 2024 08:39:38 -0700 Subject: [PATCH 2/8] Stashing changes temporarily --- .vscode/settings.json | 3 + docs/extensions-plugins/jupyterlab.mdx | 173 ------------------ .../jupyterlab/features.mdx | 86 +++++++++ .../jupyterlab/how-to-guides.mdx | 33 ++++ docs/extensions-plugins/jupyterlab/index.mdx | 25 +++ .../jupyterlab/quickstart.mdx | 78 ++++++++ .../jupyterlab/troubleshooting.mdx | 25 +++ .../raycast/troubleshooting.mdx | 2 +- sidebars.ts | 44 ++++- src/lib/const.ts | 3 +- 10 files changed, 292 insertions(+), 180 deletions(-) delete mode 100644 docs/extensions-plugins/jupyterlab.mdx create mode 100644 docs/extensions-plugins/jupyterlab/features.mdx create mode 100644 docs/extensions-plugins/jupyterlab/how-to-guides.mdx create mode 100644 docs/extensions-plugins/jupyterlab/index.mdx create mode 100644 docs/extensions-plugins/jupyterlab/quickstart.mdx create mode 100644 docs/extensions-plugins/jupyterlab/troubleshooting.mdx diff --git a/.vscode/settings.json b/.vscode/settings.json index d9d89060f..3d897ba64 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -4,6 +4,9 @@ "mdx" ], "cSpell.words": [ + "jupyterlab", + "quickstart", + "raycast", "webp" ] } \ No newline at end of file diff --git a/docs/extensions-plugins/jupyterlab.mdx b/docs/extensions-plugins/jupyterlab.mdx deleted file mode 100644 index a208e1f14..000000000 --- a/docs/extensions-plugins/jupyterlab.mdx +++ /dev/null @@ -1,173 +0,0 @@ ---- -title: Pieces for Developers JupyterLab Extension -description: Learn how to install the Pieces for JupyterLab Extension via the PYPI Manager, Pip, and Conda. ---- - -import { pieces_app } from "/src/lib/const"; -import { MiniSpacer } from "/src/components/Spacers"; -import CTAButton from "/src/components/CTAButton"; -import GridFlexRow from "/src/components/GridFlexRow"; - - - - - -_Pieces For Developers captures **NO identifiable user data**. Our **Local-only** architecture means your data never has to leave your device._ - -_The [Pieces Suite](/installation-getting-started/what-am-i-installing) must be downloaded and installed separately from the JupyterLab Extension for it to work properly._ - -## Installation Instructions - ---- - -1. Run this command: - ```sh - pip install jupyter-pieces - ``` -2. *(optional)* Be sure to have extensions enabled: [Read about enabling extensions](https://tljh.jupyter.org/en/latest/howto/admin/enable-extensions.html) - -:::info - -Be sure to accept the disclaimer before moving forward in this process. - -::: - -## Newest Features - ---- - -### Pieces Copilot powered by qGPT -- Make sure Pieces OS is open and updated to the latest available version. -- To view the Copilot, open the Pieces JupyterLab Extension and click the bot logo on the top slider to switch to Copilot -- Interact with the Pieces Copilot and receive answers that are specific to your notebooks. -- You can 'Ask Copilot' about a specific piece of code by highlighting it in a cell, right-clicking, and clicking on 'Ask Copilot' -- [A familiar chat experience spread across all your favorite text editing softwares](/features/pieces-copilot#plugin-integrations) - - The Copilot chat window has the same familiar features integrated into multiple text editing softwares: VS Code, Jetbrains, Visual Studio, Web Extension, Obsidian, and JupyterLab. - -### Enrich Selected Code -Select any text within a code cell in your notebook, right-click, and add a useful description to it. - -### Realtime Streaming -Any changes you make across any Pieces integration (e.g., the Pieces Desktop App, the Pieces VS Code Extension, the Pieces JetBrains Plugin, etc.) will automatically be reflected in the JupyterLab plugin. - -## Save your Snippets - -**To save a snippet:** - -- Highlight the text, right-click, and select "Save to Pieces." -- Click the Pieces button within any code block. -- Highlight the desired code and use a dedicated keyboard shortcut. - -![Example of saving an active cell as a snippet](https://storage.googleapis.com/pieces_multimedia/PROMOTIONAL/PIECES_FOR_DEVELOPERS/JUPYTER/MACOS/RIGHT_CLICK_SAVE_SELECTION/16X9/PIECES_FOR_DEVELOPERS-JUPYTER-RIGHT_CLICK_SAVE_SELECTION-16X9-MACOS-6_22_2023.gif) - -## Find your Snippets - -Open the Pieces View from the Ribbon Menu. - -- Sort by **recent** or by **language** -- Search your snippets to save time leafing through your files. - -![Example of searching for and inserting snippets](https://storage.googleapis.com/pieces_multimedia/PROMOTIONAL/PIECES_FOR_DEVELOPERS/JUPYTER/MACOS/SEARCH_AND_INSERT/16X9/PIECES_FOR_DEVELOPERS-JUPYTER-SEARCH_AND_INSERT-16X9-MACOS-6_22_2023.gif) - -## Use your Snippets - -- Copy and share your snippets from the Pieces View -- You can expand your code snippets to view automatically generated metadata -- View your snippets with syntax highlighting - -![Example of viewing all context related to snippet in expanded view](https://storage.googleapis.com/pieces_multimedia/PROMOTIONAL/PIECES_FOR_DEVELOPERS/JUPYTER/MACOS/EXPANDED_VIEW/16X9/PIECES_FOR_DEVELOPERS-JUPYTER-EXPANDED_VIEW-16X9-MACOS-6_22_2023.gif) - -## Share your Snippets - -**To share a snippet:** - -1. Highlight the text, right-click, and select "Share via Pieces Link." -2. Click the Pieces Share button within any code block/in the Pieces View. -3. Highlight the desired code and use a dedicated keyboard shortcut. - -![Example of generating a shareable link for a snippet](https://storage.googleapis.com/pieces_multimedia/PROMOTIONAL/PIECES_FOR_DEVELOPERS/JUPYTER/MACOS/SNIPPET_BUTTON_SHARE/16X9/PIECES_FOR_DEVELOPERS-JUPYTER-SNIPPET_BUTTON_SHARE-16X9-MACOS-6_22_2023.gif) - -_Pieces stores all of your snippets for seamless sharing._ - -## Discover Snippets - -The snippet list feature also includes a tab that is labeled *Discover*. Navigating to this tab you will see a list of snippets that Pieces discovered in your project. A great way to get booted up with saved materials in JupyterLab! - -![Example of discovered snippets in Jupyter Lab](/jupyterlab/PIECES_FOR_DEVELOPERS-JUPYTER-MACOS-SNIPPET_DISCOVERY-jupyterlab-snippet-discovery.gif) - -## Embedded Button - -Pieces adds an **embedded button** into your code cells. - -![Example of saving an active cell using the embedded buttons](https://storage.googleapis.com/pieces_multimedia/PROMOTIONAL/PIECES_FOR_DEVELOPERS/JUPYTER/MACOS/EMBEDDED_BUTTON_SAVE_ACTIVE_CELL/16X9/PIECES_FOR_DEVELOPERS-JUPYTER-EMBEDDED_BUTTON_SAVE_ACTIVE_CELL-16X9-MACOS-6_22_2023.gif) - ---- - -## Data Privacy, Security, and Offline-First Approach - -In **Pieces for Developers**, we not only prioritize your data privacy and security but also align our approach with the philosophy of JupyterLab: Offline-first, ensuring an optimal user experience. Here are key features that uphold these principles: - -- **Privacy and Security**: All user data, including code snippets, are stored directly on your device, reinforcing our commitment to data privacy. - -![Privacy and security details](/assets/jupyterlab/finder_window_privacy.png) - -- **On-Device ML Processing**: We carry out ~80% of machine learning processing on-device, which minimizes exposure to third-party servers. - -- **Offline-First Design**: Like JupyterLab, our tool is built to work seamlessly offline and provides robust functionality even without internet connectivity. - -- **Fully On-Device ML**: We're progressing toward fully on-device ML capabilities, with an aim to ship 100% of ML features on-device in Q4. - -- **Opt-In Cloud Capability**: We provide opt-in cloud features on a per-resource basis, ensuring that data transfers to the cloud only occur with your explicit consent. This grants you full control over your data. - -Just like JupyterLab, we are steadfast in our commitment to providing a tool that respects user privacy, ensures data security, and delivers a powerful offline-first experience. So, feel free to switch off your Wi-Fi and give Pieces for Developers a spin. - -## Having Trouble with the Pieces For Developers JupyterLab Extension? - -To double-check that Pieces OS is running, make sure that the Pieces logo is present in your toolbar (on macOS) or your task bar (on Windows). If it isn't there, please launch Pieces OS by clicking Pieces OS in your Applications folder. - -If you need to download and install Pieces OS, please [visit this link](/installation-getting-started/what-am-i-installing). - -### If the JupyterLab extension still isn't working for you, please make sure you have the following: -- The latest version of the Pieces for Developers JupyterLab Extension -- Pieces OS version 8.0.0 or higher -- JupyterLab version 4.0.0 or higher - -:::info - -After installing or updating your software, please restart JupyterLab. - -::: - -If none of the above fix your issue, please [submit this form](https://getpieces.typeform.com/jupyterlab) and we'll get back to you! - -## Can I Customize the Pieces Plugin? - -**Definitely!** To customize your Pieces for JupyterLab Extension experience, visit the extension settings menu and then click `Pieces Settings`. - -You can adjust the following settings: - -1. Auto-open Pieces list view on snippet save -2. Cloud capabilities -3. Pieces server port -4. Login/Logout of your Pieces Cloud - -## Support and Community - - - - - - diff --git a/docs/extensions-plugins/jupyterlab/features.mdx b/docs/extensions-plugins/jupyterlab/features.mdx new file mode 100644 index 000000000..7785350ba --- /dev/null +++ b/docs/extensions-plugins/jupyterlab/features.mdx @@ -0,0 +1,86 @@ +--- +title: Features +description: Learn how to use the Pieces JupyterLab extension features to streamline your workflow and boost productivity. +--- + +import Video from "/src/components/Video"; + +## Pieces Copilot + +Open the copilot using the Pieces View from the Ribbon Menu, and select the bot logo on the top slider to switch to Copilot + +- Interact with the Pieces Copilot and receive answers that are specific to your notebooks. +- You can 'Ask Copilot' about a specific piece of code by highlighting it in a cell, right-clicking, and clicking on 'Ask Pieces about your selection' +- [A familiar chat experience spread across all your favorite text editing software](/features/pieces-copilot#plugin-integrations) + - The Copilot chat window has the same familiar features integrated into multiple text editing softwares: VS Code, JetBrains, Visual Studio, Web Extension, Obsidian, and JupyterLab. + +### Enrich Selected Code + +Select any text within a code cell in your notebook, right-click, and the Copilot will add a helpful comment at the top describing your code. + +### Realtime Streaming + +Any changes you make across any Pieces integration (e.g., the Pieces Desktop App, the Pieces VS Code Extension, the Pieces JetBrains Plugin, etc.) will automatically be reflected in the JupyterLab extension. This means all your copilot chats and saved materials will automatically be available across all your apps that integrate with Pieces. + +## Snippets + +### Save your Snippets + +**To save a snippet, do one of the following:** + +- Highlight the text, right-click, and select "Save to Pieces." +- Click the Pieces button within any code block. +- Highlight the desired code and use a dedicated keyboard shortcut. + +![Example of saving an active cell as a snippet](https://storage.googleapis.com/pieces_multimedia/PROMOTIONAL/PIECES_FOR_DEVELOPERS/JUPYTER/MACOS/RIGHT_CLICK_SAVE_SELECTION/16X9/PIECES_FOR_DEVELOPERS-JUPYTER-RIGHT_CLICK_SAVE_SELECTION-16X9-MACOS-6_22_2023.gif) + +### Save your Snippets using the embedded Pieces Button + +Pieces adds an **embedded Pieces button** into your code cells to quickly save the contents as a snippet. + +![Example of saving an active cell using the embedded buttons](https://storage.googleapis.com/pieces_multimedia/PROMOTIONAL/PIECES_FOR_DEVELOPERS/JUPYTER/MACOS/EMBEDDED_BUTTON_SAVE_ACTIVE_CELL/16X9/PIECES_FOR_DEVELOPERS-JUPYTER-EMBEDDED_BUTTON_SAVE_ACTIVE_CELL-16X9-MACOS-6_22_2023.gif) + +### Find your Snippets + +Open the Pieces View from the Ribbon Menu. + +- Sort by **recent** or by **language** +- Search your snippets to save time manually looking through your files. + +![Example of searching for and inserting snippets](https://storage.googleapis.com/pieces_multimedia/PROMOTIONAL/PIECES_FOR_DEVELOPERS/JUPYTER/MACOS/SEARCH_AND_INSERT/16X9/PIECES_FOR_DEVELOPERS-JUPYTER-SEARCH_AND_INSERT-16X9-MACOS-6_22_2023.gif) + +### Use your Snippets + +- Copy and share your snippets from the Pieces View +- You can expand your code snippets to view automatically generated metadata +- View your snippets with syntax highlighting + +![Example of viewing all context related to snippet in expanded view](https://storage.googleapis.com/pieces_multimedia/PROMOTIONAL/PIECES_FOR_DEVELOPERS/JUPYTER/MACOS/EXPANDED_VIEW/16X9/PIECES_FOR_DEVELOPERS-JUPYTER-EXPANDED_VIEW-16X9-MACOS-6_22_2023.gif) + +### Share your Snippets + +**To share a snippet:** + +1. Highlight the text, right-click, and select "Share via Pieces Link." +1. Click the Pieces Share button within any code block/in the Pieces View. +1. Highlight the desired code and use a dedicated keyboard shortcut. + +![Example of generating a shareable link for a snippet](https://storage.googleapis.com/pieces_multimedia/PROMOTIONAL/PIECES_FOR_DEVELOPERS/JUPYTER/MACOS/SNIPPET_BUTTON_SHARE/16X9/PIECES_FOR_DEVELOPERS-JUPYTER-SNIPPET_BUTTON_SHARE-16X9-MACOS-6_22_2023.gif) + +_Pieces stores all of your snippets for seamless sharing._ + +### Discover Snippets + +The snippet list feature also includes a tab that is labeled *Discover*. Navigating to this tab you will see a list of snippets that Pieces discovered in your project. A great way to get booted up with saved materials in JupyterLab! + +![Example of discovered snippets in Jupyter Lab](/jupyterlab/PIECES_FOR_DEVELOPERS-JUPYTER-MACOS-SNIPPET_DISCOVERY-jupyterlab-snippet-discovery.gif) + +## Customize the Pieces settings + +To customize your Pieces for JupyterLab Extension settings, visit the _Settings Editor_ from the _Settings_ menu and then select `Pieces Settings`. + +You can adjust the following settings: + +1. Auto-open Pieces list view on snippet save +1. Cloud capabilities +1. Pieces server port diff --git a/docs/extensions-plugins/jupyterlab/how-to-guides.mdx b/docs/extensions-plugins/jupyterlab/how-to-guides.mdx new file mode 100644 index 000000000..49bbe8977 --- /dev/null +++ b/docs/extensions-plugins/jupyterlab/how-to-guides.mdx @@ -0,0 +1,33 @@ +--- +title: Pieces for Developers Raycast Extension Troubleshooting +description: Learn how to troubleshoot common issues with the Pieces for Developers Raycast Extension. +--- + +# Troubleshooting + +If you encounter any issues while using the Pieces for Developers Raycast Extension, refer to the following troubleshooting guide for solutions. + +## Common Issues + +### Node.js Installation Screen Appears on First Command Execution + +#### Problem + +When you try to run a command in Raycast for the first time, you may encounter an installation screen for Node.js. This installation may fail, preventing you from using the command. + +#### Solution + +1. **Initial Attempt**: + - If you see the Node.js installation screen, follow the prompts to install Node.js. + +2. **If Installation Fails**: + - Close Raycast. + - Restart Raycast. + - Try running the command again. + +3. **If the Issue Persists**: + - If restarting Raycast does not resolve the issue, please reach out to our support team for further assistance. + +## Contact Support + +If you continue to experience issues after trying our solutions, please to [reach out to our support team](/support) for further assistance. \ No newline at end of file diff --git a/docs/extensions-plugins/jupyterlab/index.mdx b/docs/extensions-plugins/jupyterlab/index.mdx new file mode 100644 index 000000000..0efb3d726 --- /dev/null +++ b/docs/extensions-plugins/jupyterlab/index.mdx @@ -0,0 +1,25 @@ +--- +title: Pieces for Developers JupyterLab Extension +description: Learn how to install the Pieces for JupyterLab Extension via PyPI using pip +--- + +import { CardWithCTA } from "/src/components/Card"; +import Grid from "/src/components/Grid"; +import Video from "/src/components/Video"; + +The Pieces for Developers JupyterLab extension brings the power of Pieces for Developers into your JupyterLab environment, allowing you to streamline your workflow and boost productivity. + +{/*