From 549587ef98afc0da79c6904a777c1b20a4ed6fff Mon Sep 17 00:00:00 2001 From: Mason Williams Date: Fri, 19 Jul 2024 14:40:52 -0400 Subject: [PATCH] docs: update plugin installation recommendations --- docs/extensions-plugins/jetbrains.mdx | 2 +- docs/extensions-plugins/sublime.mdx | 145 ++++++++++++---------- docs/extensions-plugins/visual-studio.mdx | 2 +- docs/extensions-plugins/vscode.mdx | 2 +- static/sublime/hero.png | Bin 0 -> 40021 bytes 5 files changed, 83 insertions(+), 68 deletions(-) create mode 100644 static/sublime/hero.png diff --git a/docs/extensions-plugins/jetbrains.mdx b/docs/extensions-plugins/jetbrains.mdx index c738b60f4..82938d6b2 100644 --- a/docs/extensions-plugins/jetbrains.mdx +++ b/docs/extensions-plugins/jetbrains.mdx @@ -24,7 +24,7 @@ Using the Pieces for Developers JetBrains Plugin in combination with the Pieces :::info -In order to use the Pieces JetBrains Plugin, you must have Pieces OS. We recommend also using the Pieces for Developers desktop app. +In order to use the Pieces JetBrains Plugin, you must have Pieces OS. We also recommend downloading the Pieces for Developers Desktop App. ::: diff --git a/docs/extensions-plugins/sublime.mdx b/docs/extensions-plugins/sublime.mdx index 8854aa1de..1b15237ef 100644 --- a/docs/extensions-plugins/sublime.mdx +++ b/docs/extensions-plugins/sublime.mdx @@ -5,12 +5,9 @@ description: Learn about the Pieces Sublime Extension, how it functions, and all import { pieces_app } from "/src/lib/const"; import CTAButton from "/src/components/CTAButton"; -import GridFlexRow from "/src/components/GridFlexRow"; import Video from "../../src/components/Video"; import { MiniSpacer } from "/src/components/Spacers"; - - # Pieces for Developers Sublime Text Plugin -:::info -Please make sure you have [**Pieces OS**](https://docs.pieces.app/installation-getting-started/what-am-i-installing) installed to run the Package. -::: - +The Pieces Sublime plugin is your gateway to managing your saved materials in Pieces directly from within Sublime Text. Seamlessly interact with Pieces OS and enhance your workflow like never before. -## Getting Started with the Pieces Sublime Plugin +## Getting Started -Welcome to the **Pieces Sublime Plugin**! +### Installation -![Pieces Sublime Plugin](https://github.com/Bishoy-at-pieces/plugin_sublime/assets/167128903/272cf4cc-60ff-4bd4-8701-3e3feb38a8b1) +:::info -The Pieces Sublime plugin is your gateway to managing your saved materials in Pieces directly from within Sublime Text. Seamlessly interact with Pieces OS and enhance your workflow like never before. +In order to use the Pieces Sublime Plugin, you must have Pieces OS. We also recommend downloading the Pieces for Developers Desktop App. -## How to install? +::: -### Stable build (Recommended): +#### Stable Build (Recommended) - Download the [package control](https://packagecontrol.io/installation) -- Open your command palette. You can use the shortcut key combination `Ctrl+Shift+P` on Windows and `Cmd+Shift+P` on MacOS. +- Open your command palette. You can use the shortcut key combination `Ctrl+Shift+P` on Windows and `Cmd+Shift+P` on macOS. - Search for `Package Control: Install Package` -- Search for Pieces and select it. -> IMPORTANT: When you first download the package, it will download and install some required dependencies. As a result, you might need to restart Sublime after installing. +- Search for `Pieces` and select it. + +:::tip -### Pre-releases: +When you first download the package, it will download and install some required dependencies. As a result, you may need to restart Sublime for Pieces to load in. + +::: + +#### Pre-releases You can download and checkout some new beta features before releasing. @@ -57,94 +56,110 @@ You can download and checkout some new beta features before releasing. - **Linux**: ~/.config/sublime-text/Installed Packages - Open Sublime and enjoy the package -## Features -### Configuration +### Initial Setup -Before diving in, let's ensure everything is set up to your liking. You can customize the LLM model or the host by navigating to: -`Preferences > Package Settings > Pieces > Settings`. -You can also open the settings from the command palette `Pieces: Open Settings`. +#### Login/Logout -### Right Click to Save to Pieces +You can log in and out of your Pieces account using the Pieces: Login or Pieces: Logout command in your command palette. However, logging in is completely optional, and you can use our product without authentication. -Saving a new snippet in Pieces is a breeze! Just select the code you want to save, right-click to open the context menu, and choose `Pieces > Save to Pieces`. Your code is now safely stored! +