Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Keyboard symbols #439

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/early-access-program.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Our main priority for this program is to test our latest features in as many dev
## How to Join
If you are not currently a part of the Pieces for Developers Early Access Program, you can sign up within the Pieces Desktop App. Ensure you are signed in, then either:
- Navigate to your `Account & Cloud Integrations` settings, or
- Press `⌘/CTRL + Shift + P` to open the Pieces Power Menu and type `Early Access Program`.
- Press `⌘/ + + P` to open the Pieces Power Menu and type `Early Access Program`.

<Video type={'local'} src={'/eap/how-to-join'} />

Expand Down
10 changes: 5 additions & 5 deletions docs/extensions-plugins/azure-data-studio.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ Once you complete those steps, you should see a README.md for getting started wi
## Save snippets with Pieces for ADS
To save a query from a database, simply highlight the query and save with:
1. Keyboard Shortcut
- Windows: ```Shift + CTRL + V```
- macOS: ```Shift + ⌘ + V```
- Windows: ` + + V`
- macOS: ` + ⌘ + V`
2. Right Click
- Right-click and select "Save to Pieces" in the context menu

Expand Down Expand Up @@ -68,7 +68,7 @@ Exploring Materials with Pieces Insights allows you to learn more about a code s
To explore a material:

1. Highlight a code snippet in your editor
2. Right-click and select “Explore with Pieces Insights” or hit [Shift+Alt+E] (Windows)/[Shift+Option+E] (macOS)
2. Right-click and select “Explore with Pieces Insights” or hit `⇧ + Alt + E` (Windows)/ `⇧ + Option + E` (macOS)
3. Click the “View Insights” success message in the lower right corner of your editor
4. Pieces will open a new window with a markdown file that showcases your snippet, its description, and other associated metadata.

Expand Down Expand Up @@ -100,13 +100,13 @@ Editing a snippet that is saved to Pieces for Developers from Azure Data Studio
1. Open the Pieces Explorer using the activity bar
2. From the “Saved Pieces” drop down list, right-click on the snippet you want to change
3. Click "Edit"
4. Edit your snippet, then save by pressing ```CTRL + S``` or ```⌘ + S```
4. Edit your snippet, then save by pressing ``` + S``` or ```⌘ + S```

## Search for snippets in Azure Data Studio
To search for a snippet:

1. Open an editable file in Azure Data Studio
2. Right-click and choose "Search Pieces" or use the shortcut ```CTRL + ALT + P``` or ```⌘ + ⌥ + P```
2. Right-click and choose "Search Pieces" or use the shortcut ``` + ALT + P``` or ```⌘ + ⌥ + P```
3. Type keywords into the search bar, and when you hit enter, the snippet will be inserted into the file

## Pieces for Developers Azure Data Studio Extension Settings
Expand Down
14 changes: 7 additions & 7 deletions docs/extensions-plugins/jetbrains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ Utilize a powerful Copilot integrated into your IDE, bringing your development t
## Save Snippets to Pieces for JetBrains
To save code to Pieces from your JetBrains IDE, simply highlight the snippet or file and save with:
1. Keyboard Shortcut
- Windows: ```CTRL + P(x2)```
- macOS: ```⌘ + P```
- Windows: ` + P(x2)`
- macOS: `⌘ + P
2. Right Click
- Right-click and select `Save to Pieces`

Expand Down Expand Up @@ -105,7 +105,7 @@ If your snippets are not updating right away, try pressing the refresh button at
## Search for Snippets with the JetBrains Plugin

1. Open the Search Everywhere Window
2. Double-tap the shift key and switch to the Pieces tab _or_ Use the ```Ctrl + Shift + P``` (\[⌘⇧P\] on macOS) keyboard shortcut to open a tab focused solely on your Pieces snippets
2. Double-tap the shift key and switch to the Pieces tab _or_ Use the ``` + + P``` (\[⌘⇧P\] on macOS) keyboard shortcut to open a tab focused solely on your Pieces snippets
3. Your search queries will return snippets that you've saved

You can also find saved snippets while searching in the 'All' tab, as results come from anywhere in your IDE.
Expand All @@ -117,9 +117,9 @@ Editing a snippet is super easy and can be done within your IDE without opening

To open and edit a previously saved snippet:
1. Select the snippet in the Pieces tool window
2. Hit ```Alt + Enter``` (⌥⏎ on macOS) or right-click and select “Edit…” from the pop-up menu
2. Hit `Alt + ` (⌥⏎ on macOS) or right-click and select “Edit…” from the pop-up menu
3. Make your changes
4. Save the snippet using ```Ctrl + S``` (⌘ + S on macOS)
4. Save the snippet using ` + S` (⌘ + S on macOS)

You can adjust your snippet's name, description, and classification from the right-click context menu.

Expand Down Expand Up @@ -150,7 +150,7 @@ To Explore a material:
2. Right-click and select “Explore with Pieces Insights”
3. Click the “View Insights” success message in the lower right corner of your editor
4. Pieces will open a new window on the right toolbar with a markdown file that showcases your snippet, its description, and other associated metadata
5. To revisit explored materials, click on the Pieces icon on the right side toolbar or click `Shift + Shift` and search for Pieces Insights in the search bar
5. To revisit explored materials, click on the Pieces icon on the right side toolbar or click ` + ` and search for Pieces Insights in the search bar

If you'd like to automatically save your explored materials to your Pieces repository, go to `Settings > Tools > Pieces` and click on `Automatically save explored materials`.

Expand Down Expand Up @@ -188,7 +188,7 @@ Switch your Java runtime to JCEF enabled runtime inside your global IDE settings
It’s important to know that the latest stable release of Android Studio (Hedgehog 2023.1.1) unfortunately won’t benefit from this workaround, and it may throw errors regarding GPU processes restarting too many times. If you are using Android Studio Hedgehog, please consider downgrading to the second-latest stable release, in this case Giraffe 2022.3.1 Patch 4 **until the issue is patched in Android Studio**.

In order to switch your runtime:
1. Use `⌘ + ⇧ + A` (on macOS) or `Ctrl + ⇧ + A` (Windows/Linux) shortcut to invoke action search dialog
1. Use `⌘ + ⇧ + A` (on macOS) or ` + ⇧ + A` (Windows/Linux) shortcut to invoke action search dialog
2. Start typing "Choose Boot Java Runtime for the IDE…”
3. Select the latest version with annotation ending with "JCEF”.
4. When you click OK and restart your IDE, **Copilot should start working properly**.
Expand Down
10 changes: 5 additions & 5 deletions docs/extensions-plugins/vscode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ Utilize a powerful Copilot integrated into your IDE, bringing your development t
## Save Snippets with Pieces for VS Code
To save code to Pieces from VS Code, simply highlight the snippet and save with:
1. Keyboard Shortcut
- Windows: ```Shift + CTRL + V```
- macOS: ```Shift + ⌘ + V```
- Windows: ` + + V`
- macOS: ` + ⌘ + V
2. Right Click
- Right-click and select "Save to Pieces"
<Video type={'youtube'} src={'https://www.youtube.com/embed/W8mSaaDAYbc?si=MFbVVEr2ElRtpzCt'} alt={'Save Snippets'} />
Expand Down Expand Up @@ -86,7 +86,7 @@ Exploring Materials with Pieces Insights allows you to learn more about a code s
To Explore a material:

1. Highlight a code snippet in your editor
2. Right-click and select “Explore with Pieces Insights” or hit [Shift+Alt+E] (Windows)/[Shift+Option+E] (macOS)
2. Right-click and select “Explore with Pieces Insights” or hit `⇧ + Alt + E` (Windows)/`⇧ + Option + E` (macOS)
3. Click the “View Insights” success message in the lower right corner of your editor
4. Pieces will open a new window with a markdown file that showcases your snippet, its description, and other associated metadata.

Expand Down Expand Up @@ -119,7 +119,7 @@ Editing a snippet that is saved to Pieces for Developers from VS Code is easy! T
1. Open the Pieces Explorer using the activity bar
2. From the “Saved Pieces” drop down list, right-click on the snippet you want to change
3. Click "Edit"
4. Edit your snippet, then save by pressing ```CTRL + S``` or ```⌘ + S```
4. Edit your snippet, then save by pressing ``` + S``` or ```⌘ + S```

[//]: # (![]&#40;https://storage.googleapis.com/pieces_static_resources/vs_code_marketplace/GIFs/EDIT_A_SNIPPET&#41;)

Expand All @@ -130,7 +130,7 @@ Editing a snippet that is saved to Pieces for Developers from VS Code is easy! T
To search for a snippet:

1. Open an editable file in VS Code
2. Right-click and choose "Search Pieces" or use the shortcut ```CTRL + ALT + P``` or ```⌘ + ⌥ + P```
2. Right-click and choose "Search Pieces" or use the shortcut ``` + ALT + P``` or ```⌘ + ⌥ + P```
3. Type keywords into the search bar, and when you hit enter, the snippet will be inserted into the file

[//]: # (![]&#40;https://storage.googleapis.com/pieces_static_resources/vs_code_marketplace/GIFs/SEARCH_AND_REUSE_VS_CODE&#41;)
Expand Down
10 changes: 5 additions & 5 deletions docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ To toggle between Light Mode and Dark Mode, use the Keyboard Shortcut:

| macOS | Windows |
|---------------|------------------|
| ⌘ + Shift + T | CTRL + Shift + T |
| ⌘ + + T | + + T |

Or navigate to the Pieces User Settings -> Customize -> Toggle Light Mode.

Expand Down Expand Up @@ -561,7 +561,7 @@ These options are accessible through a keyboard shortcut, ensuring that users ca

| macOS | Windows |
|------------|--------------|
| ⌘ + Return | CTRL + Enter |
| ⌘ + Return | + |

---

Expand Down Expand Up @@ -621,7 +621,7 @@ The Pieces for Developers desktop app provides users with a few options to sort

| macOS | Windows |
|-------|----------|
| ⌘ + E | CTRL + E |
| ⌘ + E | + E |

**To Cancel Edits**, simply press the Escape key.

Expand Down Expand Up @@ -697,7 +697,7 @@ Collections allow users to save curated groups of code snippets from the cloud-h

| macOS | Windows |
|---------------|------------------|
| ⌘ + Shift + C | CTRL + Shift + C |
| ⌘ + + C | + + C |

You can also add collections from the "Add a Piece" menu.

Expand Down Expand Up @@ -728,7 +728,7 @@ In Activity View, you can see when you add or adjust context for your snippets,

| macOS | Windows |
|---------------|------------------|
| ⌘ + Shift + A | CTRL + Shift + A |
| ⌘ + + A | + + A |

### Is this a manual process?

Expand Down
30 changes: 15 additions & 15 deletions docs/features/auto-enrichment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ Pieces for Developers enriches your content as you save snippets and makes it ea

## View Metadata & Enrichment Details

**Shortcut:** `⌘/CTRL + I`
**Shortcut:** `⌘/ + I`

Pieces processes your saved materials completely in the background, giving you the ability to access more data around your resources and code snippets. You can view the information in the Pieces desktop app by:
1. Pressing `⌘/CTRL + I` to access the Context View
1. Pressing `⌘/ + I` to access the Context View
2. **In List View** clicking the "View All Context" button on the top right of the Context Preview
3. **In Gallery View** clicking the "View All Context" icon in the bottom left corner
- When hovering over this icon, click the gear to manage how often the overlay appears.
Expand All @@ -42,11 +42,11 @@ Once you enter the Context View, you will see data added both automatically via
Whether you are in List or Gallery View, you will have access to the same set of enrichments.

### Annotations
**Shortcut:** `⌘/CTRL + Shift + N`
**Shortcut:** `⌘/ + + N`

Annotations allow you to include and categorize so much context about your code, from descriptions to summaries and Git commit messages.

Pieces for Developers auto-generates descriptions and other annotations, but you can manually add or reclassify information. To add or edit an annotation, go to the Context Menu and click the Annotations box, or use the keyboard shortcut `⌘/CTRL + Shift + N`.
Pieces for Developers auto-generates descriptions and other annotations, but you can manually add or reclassify information. To add or edit an annotation, go to the Context Menu and click the Annotations box, or use the keyboard shortcut `⌘/ + + N`.

You can add the following Annotations to your snippets:
- Description
Expand All @@ -60,9 +60,9 @@ You can add the following Annotations to your snippets:

### Tags

**Shortcut:** `⌘/CTRL + T`
**Shortcut:** `⌘/ + T`

Open the Tags drawer by clicking on the tags section or by using the `⌘/CTRL + T` shortcut. This will bring pull up a list of tags that were generated when you saved the resource, along with suggested tags that you can quickly add to the snippet.
Open the Tags drawer by clicking on the tags section or by using the `⌘/ + T` shortcut. This will bring pull up a list of tags that were generated when you saved the resource, along with suggested tags that you can quickly add to the snippet.

To create a custom tag, start typing and hit enter to add any tag you'd like directly into the pre-existing tags list.

Expand All @@ -88,7 +88,7 @@ Tags that you write yourself and add to your resources. They will not contain th
To remove a tag:
1. Press the `X` icon to the right of a tag
2. A dialog will open up, and you can hit "Delete" to confirm the removal of the tag
- You can also press `Enter` or `Return`
- You can also press `` or `Return`

To cancel the deletion, press `Esc` to go back to the tags drawer

Expand All @@ -98,9 +98,9 @@ To cancel the deletion, press `Esc` to go back to the tags drawer

### Related Links

**Shortcut:** `⌘/CTRL + K`
**Shortcut:** `⌘/ + K`

Related Links can be opened by clicking on the background of the Related Links section or via the `⌘/CTRL + K` shortcut. Clicking any of the individual links directly will cause them to open in your browser.
Related Links can be opened by clicking on the background of the Related Links section or via the `⌘/ + K` shortcut. Clicking any of the individual links directly will cause them to open in your browser.

Note: In the header of this section, you can see the total number of Related Links that you have.

Expand All @@ -127,8 +127,8 @@ They will still include the website's favicon.
#### Deleting Related Links
To remove a specific link from its resource, inside the Related Links drawer:
- Press the `trashcan` icon next to the `copy` icon to the right of the link
- A confirmation drawer will open; you can confirm the removal by pressing the `Delete` key
- You can also press `Enter` or `Return`
- A confirmation drawer will open; you can confirm the removal by pressing the `` key
- You can also press ``
- To cancel the deletion, press `Esc` to go back to the Related Links drawer

*(Optional)* You can press "Do not ask me again" to quickly delete a number of links from a snippet, but we recommend keeping this setting turned on to protect against accidental deletions.
Expand All @@ -137,9 +137,9 @@ To remove a specific link from its resource, inside the Related Links drawer:

### Shareable Links

**Shortcut:** `⌘/CTRL + L`
**Shortcut:** `⌘/ + L`

Shareable links can be generated using the `⌘/CTRL + L` shortcut or by clicking on the corresponding section in the Context View. This will open the Shareable Link drawer where you can manage the shareable link for a specific resource.
Shareable links can be generated using the `⌘/ + L` shortcut or by clicking on the corresponding section in the Context View. This will open the Shareable Link drawer where you can manage the shareable link for a specific resource.

**Note that all code snippets and resources have their own unique shareable link, and each link has to be generated separately.**

Expand All @@ -149,11 +149,11 @@ Read about all the [ins-and-outs of shareable links](/features/one-click-snippet

### Related People

Shortcut: `⌘/CTRL + P`
Shortcut: `⌘/ + P`

To facilitate communication among and between teams, Pieces for Developers attaches Related People to your saved snippets. Related People include content authors, open-source maintainers, GitHub collaborators, and others who are part of a snippet's context.

To access Related People, you can click the Related People section or press the `⌘/CTRL + P` shortcut.
To access Related People, you can click the Related People section or press the `⌘/ + P` shortcut.

<Video
type={'local'}
Expand Down
6 changes: 3 additions & 3 deletions docs/features/back-up-and-restore.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Please quit Pieces OS and Pieces Desktop and make sure neither are actively runn
<TabItem value="macOS">
Open your Finder and navigate to your `Home` folder.

_If you cannot see your Home folder on the left-hand side of your Finder, simply tap `Shift+Cmd+H` to open it_
_If you cannot see your Home folder on the left-hand side of your Finder, simply tap `⇧ + ⌘ + H` to open it_

![Navigating to home folder](/assets/backup_database/navigate_to_home.png)
</TabItem>
Expand All @@ -136,7 +136,7 @@ Please quit Pieces OS and Pieces Desktop and make sure neither are actively runn

<Tabs defaultValue={"macOS"} values={[{label: 'macOS', value: 'macOS'}, {label: 'Windows', value: 'windows'}, {label: 'Linux', value: 'linux'} ]}>
<TabItem value="macOS">
Once in your Home folder, you’ll need to click `Shift+Cmd+.` (shift, command, period) to show your hidden files & folders. Once they are visible, find your `Library` folder and click it.
Once in your Home folder, you’ll need to click `⇧ + ⌘ + .` (shift, command, period) to show your hidden files & folders. Once they are visible, find your `Library` folder and click it.

![Selecting your Library Folder](/assets/backup_database/selecting_library_folder.png)
</TabItem>
Expand All @@ -153,7 +153,7 @@ Please quit Pieces OS and Pieces Desktop and make sure neither are actively runn
Once in your `{username}` folder, you'll need to find your `Documents` folder and click it.

<Admonition type="info">
You may need to enable the option to show hidden files and folders. To do this, open File Explorer, and tap `Ctrl+H`.
You may need to enable the option to show hidden files and folders. To do this, open File Explorer, and tap `+H`.
</Admonition>

You should now be at the following location: `~/Users/{username}/Documents`
Expand Down
2 changes: 1 addition & 1 deletion docs/features/creation-and-generation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Utilizing the power of ChatGPT, in-house AI models, and other multimodal strateg
Use natural language to fully describe the code that will assist you in your project from the "Describe a Snippet" menu. To access this feature:
1. Open the "Describe a Snippet" Overlay:
- Select the "Add +" button beneath the carousel in Gallery View or the "+ Add Snippets" button in List View
- Press `⌘/CTRL + Shift + P` to open the overlay immediately
- Press `⌘/ + + P` to open the overlay immediately

2. After the menu opens, you can begin typing in the search bar (marked with a ">"). Here is an example phrase for you to try:

Expand Down
Loading