From 99428515847823a8c8211387aaf9a4e7e4d50933 Mon Sep 17 00:00:00 2001 From: ambaradan Date: Mon, 13 Mar 2023 16:21:58 +0100 Subject: [PATCH 1/4] Added admonitions regarding incompatibility of custom configuration with NvChad 2.0 --- docs/books/nvchad/custom/custom_folder.md | 4 ++++ docs/books/nvchad/index.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/books/nvchad/custom/custom_folder.md b/docs/books/nvchad/custom/custom_folder.md index da29b6f56c..fa3f7f87a1 100644 --- a/docs/books/nvchad/custom/custom_folder.md +++ b/docs/books/nvchad/custom/custom_folder.md @@ -13,6 +13,10 @@ tags: ## Introduction +!!! warning + + With the release of version 2.0 of NvChad the custom configuration proposed in this guide is no longer compatible and indeed would break the configuration, so pending the necessary changes we caution against **not applying** the instructions contained here on a version 2.0 installation. + NvChad uses `git` for updates. This implies that at every update, part or the whole configuration is overwritten by new commits. Consequently it would be useless to make customizations within the default configuration. To solve this problem the NvChad developers have set up the `custom` folder which **must** be placed in `.config/nvim/lua/`, and is designed to house all of your custom configuration files. Below we have a representation of the basic structure of a standard NvChad installation. diff --git a/docs/books/nvchad/index.md b/docs/books/nvchad/index.md index c96bbdfb67..b549b850ac 100644 --- a/docs/books/nvchad/index.md +++ b/docs/books/nvchad/index.md @@ -11,6 +11,10 @@ tags: # Introduction +!!! warning + + With the release of version 2.0 of NvChad the custom configuration proposed in this guide is no longer compatible and indeed would break the configuration, so pending the necessary changes we caution against **not applying** the instructions contained here on a version 2.0 installation. + Throughout this book, you will find ways to implement Neovim, along with NvChad, to create a fully functional **I**ntegrated **D**evelopment **E**nvironment (IDE). I say "ways" because there are many possibilities. The author focuses here on using these tools for writing markdown, but if markdown isn't your focus, don't worry simply read on. If you are unfamiliar with either of these tools (NvChad or Neovim), then this book will give you an introduction to both, and if you step through these documents, you'll soon realize that you can set up this environment to be a huge help for whatever your programming or script writing needs are. From 5eb80c0533bf52346977fe4297d0096f52dbe9f4 Mon Sep 17 00:00:00 2001 From: sspencerwire Date: Mon, 13 Mar 2023 11:41:10 -0500 Subject: [PATCH 2/4] Update custom_folder.md Combine admonition to 2 sentences. --- docs/books/nvchad/custom/custom_folder.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/books/nvchad/custom/custom_folder.md b/docs/books/nvchad/custom/custom_folder.md index fa3f7f87a1..36374761ff 100644 --- a/docs/books/nvchad/custom/custom_folder.md +++ b/docs/books/nvchad/custom/custom_folder.md @@ -15,7 +15,7 @@ tags: !!! warning - With the release of version 2.0 of NvChad the custom configuration proposed in this guide is no longer compatible and indeed would break the configuration, so pending the necessary changes we caution against **not applying** the instructions contained here on a version 2.0 installation. + With the release of version 2.0 of NvChad the custom configuration proposed in this guide is no longer compatible and indeed would break the configuration. Pending the necessary changes we caution against **not applying** the instructions contained here on a version 2.0 installation. NvChad uses `git` for updates. This implies that at every update, part or the whole configuration is overwritten by new commits. Consequently it would be useless to make customizations within the default configuration. From dbc21d023a7a07c835539973ff8be9985e31de28 Mon Sep 17 00:00:00 2001 From: sspencerwire Date: Mon, 13 Mar 2023 11:42:35 -0500 Subject: [PATCH 3/4] Update index.md Convert admonition to 2 sentences. --- docs/books/nvchad/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/books/nvchad/index.md b/docs/books/nvchad/index.md index b549b850ac..082e494202 100644 --- a/docs/books/nvchad/index.md +++ b/docs/books/nvchad/index.md @@ -13,7 +13,7 @@ tags: !!! warning - With the release of version 2.0 of NvChad the custom configuration proposed in this guide is no longer compatible and indeed would break the configuration, so pending the necessary changes we caution against **not applying** the instructions contained here on a version 2.0 installation. + With the release of version 2.0 of NvChad the custom configuration proposed in this guide is no longer compatible and indeed would break the configuration. Pending the necessary changes we caution **against applying** the instructions contained here on a version 2.0 installation. Throughout this book, you will find ways to implement Neovim, along with NvChad, to create a fully functional **I**ntegrated **D**evelopment **E**nvironment (IDE). From d9a04eead47654db439f6593310500838c9570db Mon Sep 17 00:00:00 2001 From: sspencerwire Date: Mon, 13 Mar 2023 11:43:22 -0500 Subject: [PATCH 4/4] Update custom_folder.md Change wording of the admonition to eliminate a double negative. --- docs/books/nvchad/custom/custom_folder.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/books/nvchad/custom/custom_folder.md b/docs/books/nvchad/custom/custom_folder.md index 36374761ff..55188b0bd4 100644 --- a/docs/books/nvchad/custom/custom_folder.md +++ b/docs/books/nvchad/custom/custom_folder.md @@ -15,7 +15,7 @@ tags: !!! warning - With the release of version 2.0 of NvChad the custom configuration proposed in this guide is no longer compatible and indeed would break the configuration. Pending the necessary changes we caution against **not applying** the instructions contained here on a version 2.0 installation. + With the release of version 2.0 of NvChad the custom configuration proposed in this guide is no longer compatible and indeed would break the configuration. Pending the necessary changes we caution **against applying** the instructions contained here on a version 2.0 installation. NvChad uses `git` for updates. This implies that at every update, part or the whole configuration is overwritten by new commits. Consequently it would be useless to make customizations within the default configuration.