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

feat(docs): Neovim updates #561

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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: 2 additions & 0 deletions docs/extensions-plugins/neovim/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import Video from "/src/components/Video";

The Pieces Neovim plugin is your gateway to managing your saved materials and interacting with Pieces Copilot in Pieces directly from within Neovim. Seamlessly interact with Pieces OS and enhance your workflow like never before.

<Video type={'youtube'} src={'https://www.youtube.com/embed/fgwZPN4sNKg?si=lO14EzTF-MV1tJRx'} alt={'Getting Started with the Pieces Neovim Plugin'}/>

## Get Started

<Grid cols={2}>
Expand Down
13 changes: 8 additions & 5 deletions docs/extensions-plugins/neovim/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ A few things to note before you start installing the Pieces Neovim Plugin:
You can install it in MacOS/Windows by running the following command:

```bash
pip install pynvim
pip3 install pynvim
```

If you use Ubuntu 22+ or an Ubuntu-based-distro -
Expand All @@ -54,11 +54,14 @@ A few things to note before you start installing the Pieces Neovim Plugin:
touch ~/.config/nvim/init.vim
```

Note: Your Neovim configuration file can either be `init.vim` or `init.lua`. If you are using `init.lua`, you will need to add the following line to your configuration file:
:::info

Note: Your Neovim configuration file can either be `init.vim` or `init.lua`. If you are using `init.lua`, you will need to add the following line to your configuration file:

```lua
vim.cmd [[packadd pieces.nvim]]
```
```lua
vim.cmd [[packadd pieces.nvim]]
```
:::

## Steps

Expand Down
12 changes: 12 additions & 0 deletions docs/extensions-plugins/neovim/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,18 @@ Ensure that you have installed the `pynvim` package. You can do this by running
pip install pynvim
```

### Issue with support for Python Version 3.12

#### Problem

When attempting to run the Neovim plugin with Python version 3.12 you may encounter the following error: `TypeError: ForwardRef._evaluate() missing 1 required keyword-only argument: 'recursive_guard'`.

This is a known issue in Python 3.12 and this error occurs due to changes in the Python 3.12 implementation that affect how forward references are evaluated, causing compatibility issues with the plugin's code.

#### Solution

The most straightforward solution for now is to use Python 3.11 or earlier. You can switch to an earlier version using a version manager like pyenv. We recommend to regularly check the Pieces Neovim Plugin repository for updates that may address this compatibility issue.

## Contact Support

If you continue to experience issues after trying our solutions, please to [reach out to our support team](/support) for further assistance.