From 4d42e792c5fe71156ca5618513645a0e825e2fc2 Mon Sep 17 00:00:00 2001 From: innovaker <66737976+innovaker@users.noreply.github.com> Date: Wed, 11 Nov 2020 14:12:14 +0000 Subject: [PATCH] refactor(docs): Remove explicit document ids Aligns older documents with newer file-based ids. --- docs/docs/customization.md | 1 - docs/docs/dev-boards-shields-keymaps.md | 1 - docs/docs/{dev-build.md => dev-build-flash.md} | 1 - docs/docs/dev-clean-room.md | 1 - docs/docs/dev-guide-usb-logging.md | 1 - docs/docs/dev-posix-board.md | 1 - docs/docs/dev-setup.md | 3 +-- docs/docs/dev-tests.md | 1 - docs/docs/faq.md | 1 - docs/docs/feature/keymaps.md | 1 - docs/docs/hardware.md | 1 - docs/docs/intro.md | 1 - docs/docs/troubleshooting.md | 1 - docs/docs/user-setup.md | 1 - 14 files changed, 1 insertion(+), 15 deletions(-) rename docs/docs/{dev-build.md => dev-build-flash.md} (99%) diff --git a/docs/docs/customization.md b/docs/docs/customization.md index b42656d8..d3372da2 100644 --- a/docs/docs/customization.md +++ b/docs/docs/customization.md @@ -1,5 +1,4 @@ --- -id: customization title: Customizing ZMK/`zmk-config` folders sidebar_label: Customizing ZMK --- diff --git a/docs/docs/dev-boards-shields-keymaps.md b/docs/docs/dev-boards-shields-keymaps.md index 9ed5a328..119db420 100644 --- a/docs/docs/dev-boards-shields-keymaps.md +++ b/docs/docs/dev-boards-shields-keymaps.md @@ -1,5 +1,4 @@ --- -id: dev-boards-shields-keymaps title: Boards, Shields, and Keymaps --- diff --git a/docs/docs/dev-build.md b/docs/docs/dev-build-flash.md similarity index 99% rename from docs/docs/dev-build.md rename to docs/docs/dev-build-flash.md index 3e6b19ad..bfdd464d 100644 --- a/docs/docs/dev-build.md +++ b/docs/docs/dev-build-flash.md @@ -1,5 +1,4 @@ --- -id: dev-build-flash title: Building and Flashing sidebar_label: Building and Flashing --- diff --git a/docs/docs/dev-clean-room.md b/docs/docs/dev-clean-room.md index 2f301ec7..82db3a04 100644 --- a/docs/docs/dev-clean-room.md +++ b/docs/docs/dev-clean-room.md @@ -1,5 +1,4 @@ --- -id: dev-clean-room title: Clean Room Implementation sidebar_label: Clean Room --- diff --git a/docs/docs/dev-guide-usb-logging.md b/docs/docs/dev-guide-usb-logging.md index 50884be5..3dc62e36 100644 --- a/docs/docs/dev-guide-usb-logging.md +++ b/docs/docs/dev-guide-usb-logging.md @@ -1,5 +1,4 @@ --- -id: dev-guide-usb-logging title: USB Logging --- diff --git a/docs/docs/dev-posix-board.md b/docs/docs/dev-posix-board.md index e146bf1f..71460a87 100644 --- a/docs/docs/dev-posix-board.md +++ b/docs/docs/dev-posix-board.md @@ -1,5 +1,4 @@ --- -id: dev-posix-board title: Native Posix board target --- diff --git a/docs/docs/dev-setup.md b/docs/docs/dev-setup.md index 604f987d..864574a4 100644 --- a/docs/docs/dev-setup.md +++ b/docs/docs/dev-setup.md @@ -1,5 +1,4 @@ --- -id: dev-setup title: Basic Setup sidebar_label: Basic Setup --- @@ -450,7 +449,7 @@ This step pulls down quite a bit of tooling. Go grab a cup of coffee, it can tak :::info If you're using Docker, you're done with setup! You must restart the container at this point. The easiest way to do so is to close the VS Code window, verify that the container has stopped in Docker Dashboard, and reopen the container with VS Code. -Once your container is restarted, proceed to [Building and Flashing](./dev-build.md). +Once your container is restarted, proceed to [Building and Flashing](./dev-build-flash.md). ::: #### Export Zephyr™ Core diff --git a/docs/docs/dev-tests.md b/docs/docs/dev-tests.md index d44c4a09..98381d7f 100644 --- a/docs/docs/dev-tests.md +++ b/docs/docs/dev-tests.md @@ -1,5 +1,4 @@ --- -id: dev-tests title: Tests sidebar_label: Tests --- diff --git a/docs/docs/faq.md b/docs/docs/faq.md index 5a73110b..3822c0d8 100644 --- a/docs/docs/faq.md +++ b/docs/docs/faq.md @@ -1,5 +1,4 @@ --- -id: faq title: FAQs sidebar_label: FAQs --- diff --git a/docs/docs/feature/keymaps.md b/docs/docs/feature/keymaps.md index f9a28946..c4c16c3b 100644 --- a/docs/docs/feature/keymaps.md +++ b/docs/docs/feature/keymaps.md @@ -1,5 +1,4 @@ --- -id: keymaps title: Keymaps & Behaviors sidebar_label: Keymaps --- diff --git a/docs/docs/hardware.md b/docs/docs/hardware.md index 6df60195..b142bda0 100644 --- a/docs/docs/hardware.md +++ b/docs/docs/hardware.md @@ -1,5 +1,4 @@ --- -id: hardware title: Supported Hardware sidebar_label: Supported Hardware --- diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 8edc3137..c76e4b7c 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -1,5 +1,4 @@ --- -id: intro title: Introduction to ZMK sidebar_label: Introduction slug: / diff --git a/docs/docs/troubleshooting.md b/docs/docs/troubleshooting.md index c45cfcce..f11d02e4 100644 --- a/docs/docs/troubleshooting.md +++ b/docs/docs/troubleshooting.md @@ -1,5 +1,4 @@ --- -id: troubleshooting title: Troubleshooting sidebar_title: Troubleshooting --- diff --git a/docs/docs/user-setup.md b/docs/docs/user-setup.md index cdc82cab..703e118a 100644 --- a/docs/docs/user-setup.md +++ b/docs/docs/user-setup.md @@ -1,5 +1,4 @@ --- -id: user-setup title: Installing ZMK sidebar_label: Installing ZMK ---