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

Raycast updates #529

Merged
merged 3 commits into from
Aug 8, 2024
Merged
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
1 change: 1 addition & 0 deletions docs/extensions-plugins/raycast/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The Pieces for Developers Raycast Extension brings powerful features to your fin
<Grid cols={2}>
<CardWithCTA title={'Quickstart'} description={'Learn how to set up and start using the Pieces for Developers Raycast Extension'} href={'/extensions-plugins/raycast/quickstart'} />
<CardWithCTA title={'View Commands'} description={'Explore the available commands for the Raycast Extension'} href={'/extensions-plugins/raycast/commands'} />
<CardWithCTA title={'Troubleshooting'} description={'Learn how to troubleshoot common issues with the Raycast Extension'} href={'/extensions-plugins/raycast/troubleshooting'} />
</Grid>

## Need Help?
Expand Down
12 changes: 3 additions & 9 deletions docs/extensions-plugins/raycast/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,6 @@ description: Learn how to set up and start using the Pieces for Developers Rayca

# Quickstart

:::warning

The Pieces for Developers Raycast Extension is currently under review and not yet available in the Raycast Store.

You can follow the progress of the review in this GitHub pull request: [Add Pieces for Developers Raycast Extension](https://github.com/raycast/extensions/pull/13626)

:::

In this tutorial, you'll learn how to set up and start using the Pieces for Developers Raycast Extension. We'll cover the installation process and basic usage to help you get up and running quickly.

## Prerequisites
Expand All @@ -32,11 +24,13 @@ If this is your first time installing an extension, you can follow the [How to I

1. Open Raycast
2. Navigate to the Raycast Store
3. Search for "Pieces for Developers"
3. Search for "Pieces for Raycast"
4. Install the Pieces for Developers Raycast Extension

### Step 2: Use the Raycast Extension

> You may find that node.js has not been set up in your Raycast environment. You will just need to wait until it installs automatically.

1. Open Raycast
2. Use the command `Search Saved Snippets` to search through your saved code snippets

Expand Down
33 changes: 33 additions & 0 deletions docs/extensions-plugins/raycast/troubleshooting.mdx
Original file line number Diff line number Diff line change
@@ -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 solutoins, please to [reach out to our support team](/support) for further assistance.
5 changes: 5 additions & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -656,6 +656,11 @@ const sidebars: SidebarsConfig = {
type: 'doc',
id: 'extensions-plugins/raycast/commands',
label: 'Commands',
},
{
type: 'doc',
id: 'extensions-plugins/raycast/troubleshooting',
label: 'Troubleshooting',
}
],

Expand Down