feat: add description to mappings page

AstroNvim · Nov 10, 2023 · 5ed096b · 5ed096b
1 parent 6fcb3ca
commit 5ed096b
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 106 deletions.
diff --git a/astro.config.mjs b/astro.config.mjs
@@ -137,15 +137,15 @@ export default defineConfig({
           translations: {},
         },
         {
-          label: "Using these docs",
-          link: "/using_the_docs",
+          label: "Mappings",
+          link: "/mappings",
           collapsed: true,
           translations: {},
         },
         {
-          label: "Basic Usage",
+          label: "Using these docs",
+          link: "/using_the_docs",
           collapsed: true,
-          autogenerate: { directory: "basic-usage" },
           translations: {},
         },
         {

diff --git a/src/content/docs/basic-usage/walkthrough.md b/src/content/docs/basic-usage/walkthrough.md
diff --git a/src/content/docs/basic-usage/mappings.md → src/content/docs/mappings.md b/src/content/docs/basic-usage/mappings.md → src/content/docs/mappings.md
@@ -1,14 +1,10 @@
 ---
 id: mappings
-title: Default Mappings
-sidebar:
-  # Set a custom label for the link
-  label: Mappings
-  # Set a custom order for the link (lower numbers are displayed higher up)
-  order: 0
-  # Add a badge to the link
+title: Mappings
 ---
 
+AstroNvim generally relies on `<Leader>` driven mappings, which is default set to `<Space>`. For information on what the `<Leader>`, check out the [`:h mapleader`](https://neovim.io/doc/user/map.html#mapleader). [`which-key.nvim`](https://github.com/folke/which-key.nvim) is also used to provide help for discovering and remembering these mappings. Simply press a key like `<Space>` and a help menu will pop up with labelled menus and options.
+
 ## General Mappings
 
 | Action                      | Mappings            |