more sidebar labels

docs/api_docs.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 1
+sidebar_label: API Documentation
+---
+
 # QMK API
 
 This page describes using the QMK API. If you are an application developer you can use this API to compile firmware for any [QMK](https://qmk.fm) Keyboard.

docs/api_overview.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 0
+sidebar_label: Overview
+---
+
 # QMK API
 
 The QMK API provides an asynchronous API that Web and GUI tools can use to compile arbitrary keymaps for any keyboard supported by [QMK](https://qmk.fm/). The stock keymap template supports all QMK keycodes that do not require supporting C code. Keyboard maintainers can supply their own custom templates to enable more functionality.

docs/breaking_changes.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 0
+sidebar_label: Overview
+---
+
 # Breaking Changes
 
 This document describes QMK's Breaking Change process. A Breaking Change is any change which modifies how QMK behaves in a way that in incompatible or potentially dangerous. We limit these changes so that users can have confidence that updating their QMK tree will not break their keymaps.

docs/breaking_changes_instructions.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 1
+sidebar_label: My Pull Request Was Flagged
+---
+
 # Breaking Changes: My Pull Request Was Flagged
 
 A QMK member may have replied to your pull request stating that your submission is a breaking change. In their judgment, the changes you have proposed have greater implications for either QMK, or its users.

docs/cli.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 0
+sidebar_label: Overview
+---
+
 # QMK CLI {#qmk-cli}
 
 ## Overview {#overview}

docs/cli_commands.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 2
+sidebar_label: Commands
+---
+
 # QMK CLI Commands
 
 # User Commands

docs/cli_configuration.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 1
+sidebar_label: Configuration
+---
+
 # QMK CLI Configuration
 
 This document explains how `qmk config` works.

docs/cli_tab_complete.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 3
+sidebar_label: Tab Completion
+---
+
 # Tab Completion for QMK
 
 If you are using Bash 4.2 or later, Zsh, or FiSH you can enable Tab Completion for the QMK CLI. This will let you tab complete the names of flags, keyboards, files, and other `qmk` options.

docs/configurator_architecture.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 4
+sidebar_label: Architecture
+---
+
 # QMK Configurator Architecture
 
 This page describes the web architecture behind QMK Configurator at a high level. If you are interested in the architecture of the QMK Configurator code itself you should start at the [qmk_configurator](https://github.com/qmk/qmk_configurator) repository.

docs/configurator_default_keymaps.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 2
+sidebar_label: Adding Default Keymaps
+---
+
 # Adding Default Keymaps to QMK Configurator {#adding-default-keymaps}
 
 This page covers how to add a default keymap for a keyboard to QMK Configurator.

docs/configurator_step_by_step.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 1
+sidebar_label: Step by Step
+---
+
 # QMK Configurator: Step by Step
 
 This page describes the steps for building your firmware in QMK Configurator.

docs/configurator_troubleshooting.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 2
+sidebar_label: Troubleshooting
+---
+
 # Configurator Troubleshooting
 
 ## My .json file is not working

docs/custom_quantum_functions.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 0
+sidebar_label: Customizing Functionality
+---
+
 # How to Customize Your Keyboard's Behavior
 
 For a lot of people a custom keyboard is about more than sending button presses to your computer. You want to be able to do things that are more complex than simple button presses and macros. QMK has hooks that allow you to inject code, override functionality, and otherwise customize how your keyboard behaves in different situations.

docs/docusaurus.config.js

@@ -29,7 +29,7 @@ const config = {
   // to replace "en" with "zh-Hans".
   i18n: {
     defaultLocale: 'en',
-    locales: ['en'],
+    locales: ['en'],//, 'ja', 'zh-cn'],
   },
 
   presets: [
@@ -75,6 +75,10 @@ const config = {
           height: 32,
         },
         items: [
+          {
+            type: 'localeDropdown',
+            position: 'right',
+          },
           {
             href: 'https://github.com/qmk/qmk_firmware',
             label: 'GitHub',
@@ -82,6 +86,11 @@ const config = {
           },
         ],
       },
+      docs: {
+        sidebar: {
+          autoCollapseCategories: false
+        }
+      },
       footer: {
         style: 'dark',
         links: [

docs/driver_installation_zadig.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 1
+sidebar_label: Driver Installation with Zadig
+---
+
 # Bootloader Driver Installation with Zadig
 
 QMK presents itself to the host as a regular HID keyboard device, and as such requires no special drivers. However, in order to flash your keyboard on Windows, the bootloader device that appears when you reset the board often *does*.

docs/faq_build.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 1
+sidebar_label: Build/Compile QMK
+---
+
 # Frequently Asked Build Questions
 
 This page covers questions about building QMK. If you haven't yet done so, you should read the [Build Environment Setup](getting_started_build_tools.md) and [Make Instructions](getting_started_make_guide.md) guides.

docs/faq_debug.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 3
+sidebar_label: Debugging QMK
+---
+
 # Debugging FAQ
 
 This page details various common questions people have about troubleshooting their keyboards.

docs/faq_general.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 0
+sidebar_label: General FAQ
+---
+
 # Frequently Asked Questions
 
 ## What is QMK?

docs/faq_misc.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 2
+sidebar_label: Troubleshooting QMK
+---
+
 # Miscellaneous FAQ
 
 ## How do I test my keyboard? {#testing}

docs/feature_auto_shift.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 1
+sidebar_label: Auto Shift
+---
+
 # Auto Shift: Why Do We Need a Shift Key?
 
 Tap a key and you get its character. Tap a key, but hold it *slightly* longer

docs/feature_debounce_type.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 4
+sidebar_label: Debounce API
+---
+
 # Contact bounce / contact chatter
 
 Mechanical switches often don't have a clean single transition between pressed and unpressed states.

docs/feature_dynamic_macros.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 1
+sidebar_label: Dynamic Macros
+---
+
 # Dynamic Macros: Record and Replay Macros in Runtime
 
 QMK supports temporary macros created on the fly. We call these Dynamic Macros. They are defined by the user from the keyboard and are lost when the keyboard is unplugged or otherwise rebooted.

docs/feature_eeprom.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 5
+sidebar_label: EEPROM
+---
+
 # Persistent Configuration (EEPROM)
 
 This allows you to configure persistent settings for your keyboard.  These settings are stored in the EEPROM of your controller, and are retained even after power loss. The settings can be read with `eeconfig_read_kb` and `eeconfig_read_user`, and can be written to using `eeconfig_update_kb` and `eeconfig_update_user`. This is useful for features that you want to be able to toggle (like toggling rgb layer indication).  Additionally, you can use `eeconfig_init_kb` and `eeconfig_init_user` to set the default values for the EEPROM.

docs/feature_layouts.md

@@ -1,3 +1,7 @@
+---
+sidebar_label: Community Layouts
+---
+
 # Layouts: Using a Keymap with Multiple Keyboards
 
 The `layouts/` folder contains different physical key layouts that can apply to different keyboards.

docs/feature_leader_key.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 3
+sidebar_label: Leader Key
+---
+
 # The Leader Key: A New Kind of Modifier {#the-leader-key}
 
 If you're a Vim user, you probably know what a Leader key is. In contrast to [Combos](feature_combo.md), the Leader key allows you to hit a *sequence* of up to five keys instead, which triggers some custom functionality once complete.

docs/feature_space_cadet.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 8
+sidebar_label: Space Cadet Shift
+---
+
 # Space Cadet: The Future, Built In
 
 Steve Losh described the [Space Cadet Shift](https://stevelosh.com/blog/2012/10/a-modern-space-cadet/) quite well. Essentially, when you tap Left Shift on its own, you get an opening parenthesis; tap Right Shift on its own and you get the closing one. When held, the Shift keys function as normal. Yes, it's as cool as it sounds, and now even cooler supporting Control and Alt as well!

docs/feature_tap_dance.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 5
+sidebar_label: Tap Dance
+---
+
 # Tap Dance: A Single Key Can Do 3, 5, or 100 Different Things
 
 ## Introduction {#introduction}

docs/feature_userspace.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 5
+sidebar_label: Userspace
+---
+
 # Userspace: Sharing Code Between Keymaps
 
 If you use more than one keyboard with a similar keymap, you might see the benefit in being able to share code between them. Create your own folder in `users/` named the same as your keymap (ideally your GitHub username, `<name>`) with the following structure:

docs/feature_wpm.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 5
+sidebar_label: WPM Calculation
+---
+
 # Word Per Minute (WPM) Calculation
 
 The WPM feature uses time between keystrokes to compute a rolling average words per minute rate and makes this available for various uses.

docs/flashing.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 0
+sidebar_label: Instructions and Bootloader Information
+---
+
 # Flashing Instructions and Bootloader Information
 
 There are quite a few different types of bootloaders that keyboards use, and almost all of them use their own flashing method and tools. Luckily, projects like the [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) aim to support as many of them as possible, but this article will describe the different types of bootloaders, and available methods for flashing them.

docs/flashing_bootloadhid.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 1
+sidebar_label: Flashing ATmega32A (ps2avrgb)
+---
+
 # BootloadHID Flashing Instructions and Bootloader Information
 
 ps2avr(GB) boards use an ATmega32A microcontroller and a different bootloader. It is not flashable using the regular QMK methods.

docs/getting_started_make_guide.md

@@ -1,3 +1,7 @@
+---
+sidebar_label: Make Documentation
+---
+
 # More Detailed `make` Instructions
 
 The full syntax of the `make` command is `<keyboard_folder>:<keymap>:<target>`, where:

docs/how_keyboards_work.md

@@ -1,3 +1,7 @@
+---
+sidebar_label: How Keyboards Work
+---
+
 # How Keys Are Registered, and Interpreted by Computers
 
 In this file, you can will learn the concepts of how keyboards work over USB,

docs/keycodes.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 0
+sidebar_label: Full List
+---
+
 # Keycodes Overview
 
 When defining a [keymap](keymap.md) each key needs a valid key definition. This page documents the symbols that correspond to keycodes that are available to you in QMK.

docs/keycodes_us_ansi_shifted.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 1
+sidebar_label: US ANSI Shifted Keys
+---
+
 # US ANSI Shifted Symbols
 
 These keycodes correspond to characters that are "shifted" on a standard US ANSI keyboard. They do not have keycodes of their own but are simply shortcuts for `LSFT(kc)`, and as such send a Left Shift with the unshifted keycode, not the symbol itself.

docs/newbs.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 0
+sidebar_label: Introduction
+---
+
 # The QMK Tutorial
 
 Your computer keyboard has a processor inside of it, similar to the one inside your computer. This processor runs software that is responsible for detecting button presses and informing the computer when keys are pressed. QMK Firmware fills the role of that software, detecting button presses and passing that information on to the host computer. When you build your custom keymap, you are creating an executable program for your keyboard.

docs/newbs_building_firmware_configurator.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 0
+sidebar_label: Overview
+---
+
 # QMK Configurator
 
 [![QMK Configurator Screenshot](https://i.imgur.com/anw9cOL.png)](https://config.qmk.fm/)

docs/newbs_building_firmware_workflow.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 4
+sidebar_label: Building with Github Userspace
+---
+
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 

docs/newbs_getting_started.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 1
+sidebar_label: Setup
+---
+
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 

docs/newbs_git_best_practices.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 0
+sidebar_label: Introduction
+---
+
 # Best Git Practices for Working with QMK
 
 ## Or, "How I Learned to Stop Worrying and Love Git."

docs/newbs_git_resolving_merge_conflicts.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 2
+sidebar_label: Merge Conflicts
+---
+
 # Resolving Merge Conflicts
 
 Sometimes when your work in a branch takes a long time to complete, changes that have been made by others conflict with changes you have made to your branch when you open a pull request. This is called a *merge conflict*, and is what happens when multiple people edit the same parts of the same files.

docs/newbs_git_resynchronize_a_branch.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 3
+sidebar_label: Fixing Your Branch
+---
+
 # Resynchronizing an Out-of-Sync Git Branch
 
 Suppose you have committed to your `master` branch, and now need to update your QMK repository. You could `git pull` QMK's `master` branch into your own, but GitHub will tell you that your branch is a number of commits ahead of `qmk:master`, which can create issues if you want to make a pull request to QMK.

docs/newbs_git_using_your_master_branch.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 1
+sidebar_label: Your Fork
+---
+
 # Your Fork's Master: Update Often, Commit Never
 
 It is highly recommended for QMK development, regardless of what is being done or where, to keep your `master` branch updated, but ***never*** commit to it. Instead, do all your changes in a development branch and issue pull requests from your branches when you're developing.

docs/other_eclipse.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 0
+sidebar_label: Using Eclipse with QMK
+---
+
 # Setting up Eclipse for QMK Development
 
 [Eclipse][1] is an open-source [Integrated Development Environment](https://en.wikipedia.org/wiki/Integrated_development_environment) (IDE) widely used for Java development, but with an extensible plugin system that allows to customize it for other languages and usages.

docs/other_vscode.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 1
+sidebar_label: Using VSCode with QMK
+---
+
 # Setting up Visual Studio Code for QMK Development
 
 [Visual Studio Code](https://code.visualstudio.com/) (VS Code) is an open-source code editor that supports many different programming languages. 

docs/ref_functions.md

@@ -1,3 +1,7 @@
+---
+sidebar_label: Useful Functions
+---
+
 # List of Useful Core Functions To Make Your Keyboard Better
 
 There are a lot of hidden functions in QMK that are incredibly useful, or may add a bit of functionality that you've been wanting.  Functions that are specific to certain features are not included here, as those will be on their respective feature page.

docs/reference_configurator_support.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 2
+sidebar_label: Keyboard Support
+---
+
 # Supporting Your Keyboard in QMK Configurator
 
 This page covers how to properly support keyboards in the [QMK Configurator](https://config.qmk.fm/).

docs/reference_glossary.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 2
+sidebar_label: Glossary
+---
+
 # Glossary of QMK Terms
 
 ## ARM

docs/reference_info_json.md

@@ -1,3 +1,7 @@
+---
+sidebar_label: info.json Format
+---
+
 # `info.json`
 
 The information contained in `info.json` is combined with the `config.h` and `rules.mk` files, dynamically generating the necessary configuration for your keyboard at compile time. It is also used by the [QMK API](https://github.com/qmk/qmk_api), and contains the information [QMK Configurator](https://config.qmk.fm/) needs to display a representation of your keyboard. Its key/value pairs are ruled by the [`data/schemas/keyboard.jsonschema`](https://github.com/qmk/qmk_firmware/blob/master/data/schemas/keyboard.jsonschema) file. To learn more about the why and how of the schema file see the [Data Driven Configuration](https://docs.qmk.fm/#/data_driven_config) page.

docs/sidebars.js

@@ -28,7 +28,7 @@ const sidebars = {
                 id: "newbs",
             },
             items: [
-                // "newbs",
+                "newbs",
                 "newbs_getting_started",
                 "newbs_building_firmware",
                 "newbs_flashing",
@@ -46,7 +46,7 @@ const sidebars = {
                 id: "faq_general",
             },
             items: [
-                // "faq_general",
+                "faq_general",
                 "faq_build",
                 "faq_misc",
                 "faq_debug",
@@ -63,7 +63,7 @@ const sidebars = {
                 id: "newbs_building_firmware_configurator",
             },
             items: [
-                // "newbs_building_firmware_configurator",
+                "newbs_building_firmware_configurator",
                 "configurator_step_by_step",
                 "configurator_troubleshooting",
                 "configurator_architecture",
@@ -75,7 +75,7 @@ const sidebars = {
                         id: "api_overview",
                     },
                     items: [
-                        // "api_overview",
+                        "api_overview",
                         "api_docs",
                         "reference_configurator_support",
                         "configurator_default_keymaps",
@@ -91,14 +91,17 @@ const sidebars = {
                 id: "cli",
             },
             items: [
-                // "cli",
+                "cli",
                 "cli_configuration",
                 "cli_commands",
                 "cli_tab_complete",
             ],
         },
         {
-            "Using QMK": [
+            type: 'category',
+            collapsed: false,
+            label: "Using QMK",
+            items: [
                 {
                     Guides: [
                         "custom_quantum_functions",
@@ -111,7 +114,15 @@ const sidebars = {
                             ],
                         },
                         {
-                            Flashing: ["flashing", "flashing_bootloadhid"],
+                            type: "category",
+                            label: "Flashing",
+                            link: {
+                                type: "doc",
+                                id: "flashing",
+                            },
+                            items: ["flashing", "flashing_bootloadhid"],
+                        },
+                        {
                             IDEs: ["other_eclipse", "other_vscode"],
                             "Git Best Practices": [
                                 "newbs_git_best_practices",
@@ -219,7 +230,10 @@ const sidebars = {
             ],
         },
         {
-            "Developing QMK": [
+            type: 'category',
+            label: "Developing QMK",
+            collapsed: false,
+            items: [
                 "pr_checklist",
                 {
                     type: "category",
@@ -229,9 +243,25 @@ const sidebars = {
                         id: "breaking_changes",
                     },
                     items: [
+                        "breaking_changes",
                         "breaking_changes_instructions",
-                        "ChangeLog/20230226",
+                        // "ChangeLog/20230226",
-                        "breaking_changes_history",
+                        // "breaking_changes_history",
+                        {
+                            type: 'category',
+                            label: "Past Breaking Changes",
+                            link: {
+                              type: 'generated-index',
+                              title: 'Past Breaking Changes',
+                              slug: '/breaking_changes/all',
+                            },
+                            items: [
+                                {
+                                    type: "autogenerated",
+                                    dirName: "ChangeLog",
+                                }
+                            ]
+                        },
                     ],
                 },
                 {
@@ -305,13 +335,13 @@ const sidebars = {
                     ],
                 },
                 {
-                  'Internals': [
+                    Internals: [
-                    {
+                        {
-                      type: 'autogenerated',
+                            type: "autogenerated",
-                      dirName: "internals"
+                            dirName: "internals",
-                    },
+                        },
-                  ]
+                    ],
-                }
+                },
             ],
         },
     ],

docs/src/css/custom.css

@@ -6,13 +6,13 @@
 
 /* You can override the default Infima variables here. */
 :root {
-  --ifm-color-primary: #855f2e;
+  --ifm-color-primary: #2d6fc5;
-  --ifm-color-primary-dark: #785829;
+  --ifm-color-primary-dark: #294e78;
-  --ifm-color-primary-darker: #715027;
+  --ifm-color-primary-darker: #274d71;
-  --ifm-color-primary-darkest: #5d4020;
+  --ifm-color-primary-darkest: #20355d;
-  --ifm-color-primary-light: #926633;
+  --ifm-color-primary-light: #335c92;
-  --ifm-color-primary-lighter: #996435;
+  --ifm-color-primary-lighter: #355899;
-  --ifm-color-primary-lightest: #ad733c;
+  --ifm-color-primary-lightest: #3c60ad;
   --ifm-code-font-size: 95%;
   --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
 }

docs/tap_hold.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 1
+sidebar_label: Tap-Hold Configuration
+---
+
 # Tap-Hold Configuration Options
 
 While Tap-Hold options are fantastic, they are not without their issues.  We have tried to configure them with reasonable defaults, but that may still cause issues for some people.