From a73f8743fe97206442fc9d8c46fc4a6cc4329948 Mon Sep 17 00:00:00 2001 From: Shivay-at-pieces <143828586+shivay-at-pieces@users.noreply.github.com> Date: Fri, 30 Aug 2024 19:28:14 +0000 Subject: [PATCH 1/2] feat(docs): small updates --- docs/extensions-plugins/neovim/quickstart.mdx | 13 ++++++++----- docs/extensions-plugins/neovim/troubleshooting.mdx | 12 ++++++++++++ 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/docs/extensions-plugins/neovim/quickstart.mdx b/docs/extensions-plugins/neovim/quickstart.mdx index be3d1063..8ac1ab8e 100644 --- a/docs/extensions-plugins/neovim/quickstart.mdx +++ b/docs/extensions-plugins/neovim/quickstart.mdx @@ -29,7 +29,7 @@ A few things to note before you start installing the Pieces Neovim Plugin: - The Python based Neovim plugins requires the `pynvim` Python package, which is not included in the default Neovim installation. You can install it by running the following command: ```bash - pip install pynvim + pip3 install pynvim ``` - Ensure that you have at least one Neovim package manager installed. For instance, you can install `vim-plug`. @@ -47,11 +47,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 diff --git a/docs/extensions-plugins/neovim/troubleshooting.mdx b/docs/extensions-plugins/neovim/troubleshooting.mdx index 25116c30..88ef91ce 100644 --- a/docs/extensions-plugins/neovim/troubleshooting.mdx +++ b/docs/extensions-plugins/neovim/troubleshooting.mdx @@ -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. \ No newline at end of file From f0fee76ba54776cb0fb4d1c1d3eefcd73b980a58 Mon Sep 17 00:00:00 2001 From: Shivay-at-pieces <143828586+shivay-at-pieces@users.noreply.github.com> Date: Mon, 16 Sep 2024 14:02:11 +0000 Subject: [PATCH 2/2] Add Youtube embed for Neovim getting started --- docs/extensions-plugins/neovim/index.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/extensions-plugins/neovim/index.mdx b/docs/extensions-plugins/neovim/index.mdx index 2812103d..7b792ad7 100644 --- a/docs/extensions-plugins/neovim/index.mdx +++ b/docs/extensions-plugins/neovim/index.mdx @@ -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. +