From ce6799c9d8d80eacd5935a4830bff64398b2e4a6 Mon Sep 17 00:00:00 2001
From: NotAShelf <raf@notashelf.dev>
Date: Thu, 7 Nov 2024 15:07:02 +0300
Subject: [PATCH] docs/plugins: rename to 'quirks' to be more general

---
 docs/manual/plugins.md                    | 16 ----------------
 docs/manual/quirks.md                     | 13 +++++++++++++
 docs/manual/{plugins => quirks}/nodejs.md | 16 +++++++++++-----
 3 files changed, 24 insertions(+), 21 deletions(-)
 delete mode 100644 docs/manual/plugins.md
 create mode 100644 docs/manual/quirks.md
 rename docs/manual/{plugins => quirks}/nodejs.md (58%)

diff --git a/docs/manual/plugins.md b/docs/manual/plugins.md
deleted file mode 100644
index fa464d1..0000000
--- a/docs/manual/plugins.md
+++ /dev/null
@@ -1,16 +0,0 @@
-# Plugin specific quirks {#ch-plugins}
-
-At times, certain plugins refuse to play nicely. Be it as a result of generating
-lua from Nix, or the state of packaging. This page shall list any plugins that
-are known to misbehave, and potential workarounds.
-
-```{=include=} chapters
-plugins/nodejs.md
-```
-<!--
-If adding a new section, uncomment this part and add your page to
-plugins/<page>.md
-```{=include=} chapters
-plugins/page.md
-```
--->
diff --git a/docs/manual/quirks.md b/docs/manual/quirks.md
new file mode 100644
index 0000000..553d6cf
--- /dev/null
+++ b/docs/manual/quirks.md
@@ -0,0 +1,13 @@
+# Known Issues and Quirks {#ch-known-issues-quirks}
+
+At times, certain plugins and modules may refuse to play nicely with your setup,
+be it a result of generating Lua from Nix, or the state of packaging. This page,
+in turn, will list any known modules or plugins that are known to misbehave, and
+possible workarounds that you may apply.
+
+<!-- If adding a new known quirk, please create a new page in quirks/ and include
+the name of the file here.-->
+
+```{=include=} chapters
+quirks/nodejs.md
+```
diff --git a/docs/manual/plugins/nodejs.md b/docs/manual/quirks/nodejs.md
similarity index 58%
rename from docs/manual/plugins/nodejs.md
rename to docs/manual/quirks/nodejs.md
index 36b4c79..d2fb46b 100644
--- a/docs/manual/plugins/nodejs.md
+++ b/docs/manual/quirks/nodejs.md
@@ -1,16 +1,22 @@
-# NodeJS {#ch-plugins-nodejs}
+# NodeJS {#ch-quirks-nodejs}
 
 ## eslint-plugin-prettier {#sec-eslint-plugin-prettier}
 
-When working with NodeJS, everything works as expected, but some projects have settings that can fool nvf.
+When working with NodeJS, everything works as expected, but some projects have
+settings that can fool nvf.
 
-If [this plugin](https://github.com/prettier/eslint-plugin-prettier) or similar is included, you might get a situation where your eslint configuration diagnoses your formatting according to its own config (usually `.eslintrc.js`).
+If [this plugin](https://github.com/prettier/eslint-plugin-prettier) or similar
+is included, you might get a situation where your eslint configuration diagnoses
+your formatting according to its own config (usually `.eslintrc.js`).
 
 The issue there is your formatting is made via prettierd.
 
-This results in auto-formating relying on your prettier config, while your eslint config diagnoses formatting [which it's not supposed to](https://prettier.io/docs/en/comparison.html))
+This results in auto-formating relying on your prettier config, while your
+eslint config diagnoses formatting
+[which it's not supposed to](https://prettier.io/docs/en/comparison.html))
 
-In the end, you get discrepancies between what your editor does and what it wants.
+In the end, you get discrepancies between what your editor does and what it
+wants.
 
 Solutions are: