From 57de02d53fa62f628cab80b2626dc841081d61d5 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 19 Jan 2022 12:32:54 -0700 Subject: [PATCH] reorganize navigation and sidebars --- docusaurus.config.js | 42 +++++++++++++++++++++--- sidebars.js | 78 ++++++++++++++++++++++++-------------------- 2 files changed, 80 insertions(+), 40 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 39a7ceb6..91069abb 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -42,6 +42,43 @@ const config = { activeBasePath: "docs/academy", }, */ + { + label: "Documentation", + items: [ + { + label: "About Meshtastic", + to: "docs/software", + }, + { + label: "Getting Started", + to: "docs/getting-started", + }, + { + label: "Device Settings", + to: "docs/settings", + }, + { + label: "Hardware Details", + to: "docs/hardware", + }, + { + label: "Contribute to Meshtastic", + to: "docs/developers", + }, + /* + TODO add Docusaurus and Vercel instructions for how to manage the docs + { + label: "About this Documentation", + to: "docs/about-documentation", + }, + */ + { + label: "Legal", + to: "docs/legal", + }, + + ], + }, { label: "Firmware", to: "firmware", @@ -52,11 +89,6 @@ const config = { to: "showcase", activeBasePath: "showcase", }, - { - label: "Docs", - to: "docs/getting-started", - activeBasePath: "docs/getting-started", - }, { href: "https://meshtastic.discourse.group", label: "Forum", diff --git a/sidebars.js b/sidebars.js index 695d61ea..3add6e24 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,16 +1,5 @@ module.exports = { - Sidebar: { - "Getting Started": [ - "getting-started/overview", - "getting-started/faq", - { - "Flashing firmware": [ - "getting-started/flashing-esp32", - "getting-started/flashing-nrf52", - ], - }, - "getting-started/concepts", - ], + About: { Software: [ "software/overview", { @@ -104,33 +93,48 @@ module.exports = { "software/other/ant", ], }, + ], + }, + GettingStarted: { + "Getting Started": [ + "getting-started/overview", + "getting-started/faq", { - Settings: [ - "software/settings/overview", - "software/settings/channel", - "software/settings/gps", - "software/settings/mqtt", - "software/settings/power", - "software/settings/router", - "software/settings/wifi", - { - Plugins: [ - "software/settings/environmental-measurement-plugin", - "software/settings/external-notification-plugin", - "software/settings/canned-message-plugin-settings", - "software/settings/range-test-plugin", - "software/settings/serial-plugin", - "software/settings/store-and-forward-plugin", - "software/settings/rotary-encoder-settings", - ], - Advanced: [ - "software/settings/channel-advanced", - "software/settings/misc", - ], - }, + "Flashing firmware": [ + "getting-started/flashing-esp32", + "getting-started/flashing-nrf52", + ], + }, + "getting-started/concepts", + ], + }, + Settings: { + Settings: [ + "software/settings/overview", + "software/settings/channel", + "software/settings/gps", + "software/settings/mqtt", + "software/settings/power", + "software/settings/router", + "software/settings/wifi", + { + Plugins: [ + "software/settings/environmental-measurement-plugin", + "software/settings/external-notification-plugin", + "software/settings/canned-message-plugin-settings", + "software/settings/range-test-plugin", + "software/settings/serial-plugin", + "software/settings/store-and-forward-plugin", + "software/settings/rotary-encoder-settings", + ], + Advanced: [ + "software/settings/channel-advanced", + "software/settings/misc", ], }, ], + }, + Hardware: { Hardware: [ "hardware/overview", { @@ -155,6 +159,8 @@ module.exports = { ], }, ], + }, + Contribute: { Developers: [ "developers/overview", { @@ -183,6 +189,8 @@ module.exports = { ], }, ], + }, + Legal: { Legal: [ "legal/overview", "legal/licensing",