From 43c72b2e6008b40a79f2607c3a614822654cee1c Mon Sep 17 00:00:00 2001 From: Theodor Rohde Date: Tue, 30 Jul 2024 13:39:56 +0200 Subject: [PATCH] change menu to single without individual sidebars --- docs/components/_category_.json | 2 +- .../enclosures/spelsberg_TG_PC_1208-6-o.md | 2 +- docs/components/firmware/_category_.json | 2 +- .../firmware/app-hybrid-modbus/index.md | 2 +- .../firmware/app-nrf91-hybrid/index.md | 2 +- .../firmware/app-nrf91-origin/index.md | 2 +- .../cellular-iot-communication-protocol.md | 2 +- .../app-nrf9160-wmbus/changelog-download.md | 2 +- .../configuration-parameter.md | 2 +- .../app-nrf9160-wmbus/introduction.md | 2 +- .../lorawan-communication-protocol.md | 2 +- docs/components/index.md | 4 ++-- docs/configuration/_category_.json | 2 +- docs/configuration/cron-configuration.md | 2 +- docs/configuration/index.md | 2 +- docs/configuration/lobaro-config-tool.md | 2 +- docs/configuration/lorawan-downlink-config.md | 2 +- .../lte-network-configuration.md | 2 +- .../meter-reception-filter-config.md | 2 +- docs/configuration/obis-code-configuration.md | 2 +- docs/configuration/usb-config-adapter.md | 2 +- docs/knowledge-base/_category_.json | 2 +- docs/knowledge-base/index.md | 9 +++++++++ docs/platform/index.md | 2 +- docs/platform/integrations/index.md | 2 +- docs/products/index.md | 2 +- .../wireless-mbus-gateway-dinrail-230V.md | 2 +- ...eless-mbus-gateway-dinrail-concentrator.md | 2 +- .../wireless-mbus-gateway-dinrail.md | 2 +- .../wireless-mbus-gateway-sun-v1.md | 2 +- .../wireless-mbus-gateway-v3.md | 2 +- docusaurus.config.ts | 18 ++++++++---------- sidebars.ts | 19 +++++++++++-------- 33 files changed, 59 insertions(+), 49 deletions(-) create mode 100644 docs/knowledge-base/index.md diff --git a/docs/components/_category_.json b/docs/components/_category_.json index 14aaadbd..b57d7252 100644 --- a/docs/components/_category_.json +++ b/docs/components/_category_.json @@ -1,5 +1,5 @@ { "label": "Components", - "position": 2, + "position": 1, "collapsed": true } diff --git a/docs/components/enclosures/spelsberg_TG_PC_1208-6-o.md b/docs/components/enclosures/spelsberg_TG_PC_1208-6-o.md index cd993cba..67e2dd73 100644 --- a/docs/components/enclosures/spelsberg_TG_PC_1208-6-o.md +++ b/docs/components/enclosures/spelsberg_TG_PC_1208-6-o.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 -displayed_sidebar: componentsSidebar +#displayed_sidebar: componentsSidebar title: Spelsberg TG PC 1208-6-o --- diff --git a/docs/components/firmware/_category_.json b/docs/components/firmware/_category_.json index 0eca2a4e..f8be4d01 100644 --- a/docs/components/firmware/_category_.json +++ b/docs/components/firmware/_category_.json @@ -1,5 +1,5 @@ { - "label": "Firmware Manuals", + "label": "Firmware", "position": 1, "collapsed": true } diff --git a/docs/components/firmware/app-hybrid-modbus/index.md b/docs/components/firmware/app-hybrid-modbus/index.md index 1fdcb701..ff7d9474 100644 --- a/docs/components/firmware/app-hybrid-modbus/index.md +++ b/docs/components/firmware/app-hybrid-modbus/index.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 -displayed_sidebar: componentsSidebar +#displayed_sidebar: componentsSidebar title: app-hybrid-modbus --- # app-hybrid-modbus diff --git a/docs/components/firmware/app-nrf91-hybrid/index.md b/docs/components/firmware/app-nrf91-hybrid/index.md index 63d12922..616db1b0 100644 --- a/docs/components/firmware/app-nrf91-hybrid/index.md +++ b/docs/components/firmware/app-nrf91-hybrid/index.md @@ -1,6 +1,6 @@ --- sidebar_position: 2 -displayed_sidebar: componentsSidebar +#displayed_sidebar: componentsSidebar title: app-nrf91-hybrid draft: true --- diff --git a/docs/components/firmware/app-nrf91-origin/index.md b/docs/components/firmware/app-nrf91-origin/index.md index aafacc84..c2a5a5ab 100644 --- a/docs/components/firmware/app-nrf91-origin/index.md +++ b/docs/components/firmware/app-nrf91-origin/index.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 -displayed_sidebar: componentsSidebar +#displayed_sidebar: componentsSidebar title: app-nrf91-origin draft: true --- diff --git a/docs/components/firmware/app-nrf9160-wmbus/cellular-iot-communication-protocol.md b/docs/components/firmware/app-nrf9160-wmbus/cellular-iot-communication-protocol.md index 042aee7c..e043788c 100644 --- a/docs/components/firmware/app-nrf9160-wmbus/cellular-iot-communication-protocol.md +++ b/docs/components/firmware/app-nrf9160-wmbus/cellular-iot-communication-protocol.md @@ -1,6 +1,6 @@ --- sidebar_position: 6 -displayed_sidebar: componentsSidebar +#displayed_sidebar: componentsSidebar title: Cellular IoT Communication --- diff --git a/docs/components/firmware/app-nrf9160-wmbus/changelog-download.md b/docs/components/firmware/app-nrf9160-wmbus/changelog-download.md index 6d3c0fe4..2a5143cc 100644 --- a/docs/components/firmware/app-nrf9160-wmbus/changelog-download.md +++ b/docs/components/firmware/app-nrf9160-wmbus/changelog-download.md @@ -1,6 +1,6 @@ --- sidebar_position: 100 -displayed_sidebar: componentsSidebar +#displayed_sidebar: componentsSidebar title: Changelog & Updates --- ## Firmware Updates diff --git a/docs/components/firmware/app-nrf9160-wmbus/configuration-parameter.md b/docs/components/firmware/app-nrf9160-wmbus/configuration-parameter.md index 7ec2f669..26d3d6ce 100644 --- a/docs/components/firmware/app-nrf9160-wmbus/configuration-parameter.md +++ b/docs/components/firmware/app-nrf9160-wmbus/configuration-parameter.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 -displayed_sidebar: componentsSidebar +#displayed_sidebar: componentsSidebar title: Configuration Parameter --- diff --git a/docs/components/firmware/app-nrf9160-wmbus/introduction.md b/docs/components/firmware/app-nrf9160-wmbus/introduction.md index a7650fae..2e192558 100644 --- a/docs/components/firmware/app-nrf9160-wmbus/introduction.md +++ b/docs/components/firmware/app-nrf9160-wmbus/introduction.md @@ -1,6 +1,6 @@ --- sidebar_position: 0 -displayed_sidebar: componentsSidebar +#displayed_sidebar: componentsSidebar title: Introduction --- diff --git a/docs/components/firmware/app-nrf9160-wmbus/lorawan-communication-protocol.md b/docs/components/firmware/app-nrf9160-wmbus/lorawan-communication-protocol.md index 26759ebc..13e29c00 100644 --- a/docs/components/firmware/app-nrf9160-wmbus/lorawan-communication-protocol.md +++ b/docs/components/firmware/app-nrf9160-wmbus/lorawan-communication-protocol.md @@ -1,6 +1,6 @@ --- sidebar_position: 5 -displayed_sidebar: componentsSidebar +#displayed_sidebar: componentsSidebar title: LoRaWAN Communication --- diff --git a/docs/components/index.md b/docs/components/index.md index 0e4ed799..cd20f4d5 100644 --- a/docs/components/index.md +++ b/docs/components/index.md @@ -1,7 +1,7 @@ --- sidebar_position: 0 -displayed_sidebar: componentsSidebar -title: Overview +# displayed_sidebar: allDocSidebar +#title: Overview --- # Product Components diff --git a/docs/configuration/_category_.json b/docs/configuration/_category_.json index 0f4eb31c..d839d2a9 100644 --- a/docs/configuration/_category_.json +++ b/docs/configuration/_category_.json @@ -1,5 +1,5 @@ { "label": "Configuration", - "position": 1, + "position": 2, "collapsed": true } diff --git a/docs/configuration/cron-configuration.md b/docs/configuration/cron-configuration.md index 5b34e8d3..87f3fff2 100644 --- a/docs/configuration/cron-configuration.md +++ b/docs/configuration/cron-configuration.md @@ -1,6 +1,6 @@ --- sidebar_position: 4 -displayed_sidebar: configurationSidebar +#displayed_sidebar: configurationSidebar title: CRON Configuration --- diff --git a/docs/configuration/index.md b/docs/configuration/index.md index 633d3e35..1b02dafd 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -1,6 +1,6 @@ --- sidebar_position: 0 -displayed_sidebar: configurationSidebar +#displayed_sidebar: configurationSidebar title: Overview --- diff --git a/docs/configuration/lobaro-config-tool.md b/docs/configuration/lobaro-config-tool.md index 4cf65c5e..e4639b81 100644 --- a/docs/configuration/lobaro-config-tool.md +++ b/docs/configuration/lobaro-config-tool.md @@ -1,6 +1,6 @@ --- sidebar_position: 2 -displayed_sidebar: configurationSidebar +#displayed_sidebar: configurationSidebar title: Lobaro Config Tool --- diff --git a/docs/configuration/lorawan-downlink-config.md b/docs/configuration/lorawan-downlink-config.md index f24b6943..5087e70a 100644 --- a/docs/configuration/lorawan-downlink-config.md +++ b/docs/configuration/lorawan-downlink-config.md @@ -1,6 +1,6 @@ --- sidebar_position: 3 -displayed_sidebar: configurationSidebar +#displayed_sidebar: configurationSidebar title: LoRaWAN Downlink Config --- diff --git a/docs/configuration/lte-network-configuration.md b/docs/configuration/lte-network-configuration.md index 351032b8..1d90b472 100644 --- a/docs/configuration/lte-network-configuration.md +++ b/docs/configuration/lte-network-configuration.md @@ -1,6 +1,6 @@ --- sidebar_position: 4 -displayed_sidebar: configurationSidebar +#displayed_sidebar: configurationSidebar title: LTE Network Configuration --- diff --git a/docs/configuration/meter-reception-filter-config.md b/docs/configuration/meter-reception-filter-config.md index 690dee93..5c5d2b8c 100644 --- a/docs/configuration/meter-reception-filter-config.md +++ b/docs/configuration/meter-reception-filter-config.md @@ -1,6 +1,6 @@ --- sidebar_position: 2 -displayed_sidebar: configurationSidebar +#displayed_sidebar: configurationSidebar title: MBUS Reception Filtering --- diff --git a/docs/configuration/obis-code-configuration.md b/docs/configuration/obis-code-configuration.md index c3b47a63..e7305ae1 100644 --- a/docs/configuration/obis-code-configuration.md +++ b/docs/configuration/obis-code-configuration.md @@ -1,6 +1,6 @@ --- sidebar_position: 4 -displayed_sidebar: configurationSidebar +#displayed_sidebar: configurationSidebar title: OBIS-Code Configuration --- diff --git a/docs/configuration/usb-config-adapter.md b/docs/configuration/usb-config-adapter.md index 877c07f8..fdafed1d 100644 --- a/docs/configuration/usb-config-adapter.md +++ b/docs/configuration/usb-config-adapter.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 -displayed_sidebar: configurationSidebar +#displayed_sidebar: configurationSidebar title: Lobaro USB Config Adapter --- diff --git a/docs/knowledge-base/_category_.json b/docs/knowledge-base/_category_.json index e4915773..375c5a2c 100644 --- a/docs/knowledge-base/_category_.json +++ b/docs/knowledge-base/_category_.json @@ -1,5 +1,5 @@ { - "label": "Background Knowledge", + "label": "Knowledge Base", "position": 5, "collapsed": true } diff --git a/docs/knowledge-base/index.md b/docs/knowledge-base/index.md new file mode 100644 index 00000000..dfc9a820 --- /dev/null +++ b/docs/knowledge-base/index.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 0 +#displayed_sidebar: configurationSidebar +#title: Overview +--- + +# Knowledge Base +--- +General knowledge. diff --git a/docs/platform/index.md b/docs/platform/index.md index 40541f9e..d6445a8a 100644 --- a/docs/platform/index.md +++ b/docs/platform/index.md @@ -1,6 +1,6 @@ --- sidebar_position: 0 -displayed_sidebar: cloudSidebar +#displayed_sidebar: cloudSidebar title: Overview --- diff --git a/docs/platform/integrations/index.md b/docs/platform/integrations/index.md index 8b1195cb..fe41fe9a 100644 --- a/docs/platform/integrations/index.md +++ b/docs/platform/integrations/index.md @@ -1,6 +1,6 @@ --- sidebar_position: 0 -displayed_sidebar: cloudSidebar +#displayed_sidebar: cloudSidebar --- # Integrations diff --git a/docs/products/index.md b/docs/products/index.md index 91747f23..59119c6b 100644 --- a/docs/products/index.md +++ b/docs/products/index.md @@ -1,6 +1,6 @@ --- sidebar_position: 0 -displayed_sidebar: productsSidebar +# displayed_sidebar: productsSidebar title: Overview --- diff --git a/docs/products/metering-gateways/wireless-mbus-gateway-dinrail-230V.md b/docs/products/metering-gateways/wireless-mbus-gateway-dinrail-230V.md index c429e9ca..3f69b2cd 100644 --- a/docs/products/metering-gateways/wireless-mbus-gateway-dinrail-230V.md +++ b/docs/products/metering-gateways/wireless-mbus-gateway-dinrail-230V.md @@ -1,6 +1,6 @@ --- sidebar_position: 3 -displayed_sidebar: productsSidebar +#displayed_sidebar: productsSidebar title: wM-Bus GW (230V) --- diff --git a/docs/products/metering-gateways/wireless-mbus-gateway-dinrail-concentrator.md b/docs/products/metering-gateways/wireless-mbus-gateway-dinrail-concentrator.md index 61dfaf76..058da4da 100644 --- a/docs/products/metering-gateways/wireless-mbus-gateway-dinrail-concentrator.md +++ b/docs/products/metering-gateways/wireless-mbus-gateway-dinrail-concentrator.md @@ -1,6 +1,6 @@ --- sidebar_position: 4 -displayed_sidebar: productsSidebar +#displayed_sidebar: productsSidebar title: wM-Bus GW (Concentrator) --- diff --git a/docs/products/metering-gateways/wireless-mbus-gateway-dinrail.md b/docs/products/metering-gateways/wireless-mbus-gateway-dinrail.md index 9008532a..0d825a4f 100644 --- a/docs/products/metering-gateways/wireless-mbus-gateway-dinrail.md +++ b/docs/products/metering-gateways/wireless-mbus-gateway-dinrail.md @@ -1,6 +1,6 @@ --- sidebar_position: 2 -displayed_sidebar: productsSidebar +#displayed_sidebar: productsSidebar title: wM-Bus GW (12V - 24V) --- diff --git a/docs/products/metering-gateways/wireless-mbus-gateway-sun-v1.md b/docs/products/metering-gateways/wireless-mbus-gateway-sun-v1.md index a70deed7..6f6685b6 100644 --- a/docs/products/metering-gateways/wireless-mbus-gateway-sun-v1.md +++ b/docs/products/metering-gateways/wireless-mbus-gateway-sun-v1.md @@ -1,6 +1,6 @@ --- sidebar_position: 5 -displayed_sidebar: productsSidebar +#displayed_sidebar: productsSidebar title: wM-Bus GW (Solar) --- diff --git a/docs/products/metering-gateways/wireless-mbus-gateway-v3.md b/docs/products/metering-gateways/wireless-mbus-gateway-v3.md index 510657ed..f5609119 100644 --- a/docs/products/metering-gateways/wireless-mbus-gateway-v3.md +++ b/docs/products/metering-gateways/wireless-mbus-gateway-v3.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 -displayed_sidebar: productsSidebar +#displayed_sidebar: productsSidebar title: wM-Bus GW V3 (Battery) --- diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 979f4043..4c33e461 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -85,32 +85,31 @@ const config: Config = { }, items: [ { - type: 'docSidebar', - sidebarId: 'productsSidebar', + to: 'products/', position: 'left', label: 'Products', }, + { - type: 'docSidebar', - sidebarId: 'componentsSidebar', + to: 'components/', position: 'left', label: 'Components', }, { - type: 'docSidebar', - sidebarId: 'configurationSidebar', + to: 'configuration/', position: 'left', label: 'Configuration', }, + { - type: 'docSidebar', - sidebarId: 'cloudSidebar', + to: 'platform', position: 'left', label: 'Lobaro IoT Platform', }, + { type: 'html', position: 'right', @@ -122,8 +121,7 @@ const config: Config = { value: '', }, { - type: 'docSidebar', - sidebarId: 'knowledgeBaseSidebar', + to: 'knowledge-base/', position: 'right', label: 'Knowledge Base', }, diff --git a/sidebars.ts b/sidebars.ts index a612caa8..bcba7627 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -32,14 +32,14 @@ allDocSidebar: { allDocSidebar: [ { type: 'category', - label: 'All Docs', + label: 'Lobaro Docs', items: [ {type: 'autogenerated', dirName: '.'}, ], }, 'knowledge-base/playground', ], - +/* configurationSidebar: [ { type: 'category', @@ -49,7 +49,8 @@ allDocSidebar: { ], }, ], - + */ +/* productsSidebar: [ { type: 'category', @@ -59,9 +60,9 @@ allDocSidebar: { ], }, ], +*/ - - +/* componentsSidebar: [ { type: 'category', @@ -71,7 +72,8 @@ allDocSidebar: { ], }, ], - +*/ + /* cloudSidebar: [ { type: 'category', @@ -81,7 +83,8 @@ allDocSidebar: { ], }, ], - +*/ + /* knowledgeBaseSidebar: [ { type: 'category', @@ -91,7 +94,7 @@ allDocSidebar: { ], }, ], - +*/ // But you can create a sidebar manually /* tutorialSidebar: [