diff --git a/docs/hw-products/_category_.json b/docs/hw-products/_category_.json new file mode 100644 index 00000000..a5cb9b2d --- /dev/null +++ b/docs/hw-products/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "Hardware Products", + "position": 1, + "collapsed": true, + "link": { + "type": "generated-index", + "description": "Lobaro IoT Hardware" + } +} diff --git a/docs/hw-products/wmbus-gateways/_category_.json b/docs/hw-products/wmbus-gateways/_category_.json new file mode 100644 index 00000000..ad42b4f8 --- /dev/null +++ b/docs/hw-products/wmbus-gateways/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Wireless M-BUS Gateways", + "position": 1, + "link": { + "type": "generated-index", + "description": "Lobaro wireless M-BUS Gateways" + } +} diff --git a/docs/hw-products/wmbus-gateways/bridge-v2/_category_.json b/docs/hw-products/wmbus-gateways/bridge-v2/_category_.json new file mode 100644 index 00000000..def7fd54 --- /dev/null +++ b/docs/hw-products/wmbus-gateways/bridge-v2/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "LoRaWAN Bridge V2", + "position": 8, + "link": { + "type": "generated-index", + "description": "Wireless M-BUS Gateways" + } +} diff --git a/docs/hw-products/wmbus-gateways/bridge-v2/description.md b/docs/hw-products/wmbus-gateways/bridge-v2/description.md new file mode 100644 index 00000000..ec54b8d9 --- /dev/null +++ b/docs/hw-products/wmbus-gateways/bridge-v2/description.md @@ -0,0 +1,47 @@ +--- +sidebar_position: 1 +--- +:::warning +This product has been discontinued and functionally replaced by the wMBUS gateway V3 / V4. +::: +# Description + +## Getting Started + +Get started by **creating a new site**. + +Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. + +### What you'll need + +- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: + - When installing Node.js, you are recommended to check all checkboxes related to dependencies. + +## Generate a new site + +Generate a new Docusaurus site using the **classic template**. + +The classic template will automatically be added to your project after you run the command: + +```bash +npm init docusaurus@latest my-website classic +``` + +You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. + +The command also installs all necessary dependencies you need to run Docusaurus. + +## Start your site + +Run the development server: + +```bash +cd my-website +npm run start +``` + +The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. + +The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. + +Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/docs/hw-products/wmbus-gateways/concentrator-v1/_category_.json b/docs/hw-products/wmbus-gateways/concentrator-v1/_category_.json new file mode 100644 index 00000000..57dd042e --- /dev/null +++ b/docs/hw-products/wmbus-gateways/concentrator-v1/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Concentrator Gateway", + "position": 6, + "link": { + "type": "generated-index", + "description": "Wireless M-BUS Gateways" + } +} diff --git a/docs/hw-products/wmbus-gateways/concentrator-v1/description.md b/docs/hw-products/wmbus-gateways/concentrator-v1/description.md new file mode 100644 index 00000000..ec54b8d9 --- /dev/null +++ b/docs/hw-products/wmbus-gateways/concentrator-v1/description.md @@ -0,0 +1,47 @@ +--- +sidebar_position: 1 +--- +:::warning +This product has been discontinued and functionally replaced by the wMBUS gateway V3 / V4. +::: +# Description + +## Getting Started + +Get started by **creating a new site**. + +Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. + +### What you'll need + +- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: + - When installing Node.js, you are recommended to check all checkboxes related to dependencies. + +## Generate a new site + +Generate a new Docusaurus site using the **classic template**. + +The classic template will automatically be added to your project after you run the command: + +```bash +npm init docusaurus@latest my-website classic +``` + +You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. + +The command also installs all necessary dependencies you need to run Docusaurus. + +## Start your site + +Run the development server: + +```bash +cd my-website +npm run start +``` + +The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. + +The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. + +Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/docs/hw-products/wmbus-gateways/dinrail-v1/_category_.json b/docs/hw-products/wmbus-gateways/dinrail-v1/_category_.json new file mode 100644 index 00000000..79ebd237 --- /dev/null +++ b/docs/hw-products/wmbus-gateways/dinrail-v1/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Din-Rail Gateway", + "position": 4, + "link": { + "type": "generated-index", + "description": "Wireless M-BUS Gateways" + } +} diff --git a/docs/hw-products/wmbus-gateways/dinrail-v1/description.md b/docs/hw-products/wmbus-gateways/dinrail-v1/description.md new file mode 100644 index 00000000..ec54b8d9 --- /dev/null +++ b/docs/hw-products/wmbus-gateways/dinrail-v1/description.md @@ -0,0 +1,47 @@ +--- +sidebar_position: 1 +--- +:::warning +This product has been discontinued and functionally replaced by the wMBUS gateway V3 / V4. +::: +# Description + +## Getting Started + +Get started by **creating a new site**. + +Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. + +### What you'll need + +- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: + - When installing Node.js, you are recommended to check all checkboxes related to dependencies. + +## Generate a new site + +Generate a new Docusaurus site using the **classic template**. + +The classic template will automatically be added to your project after you run the command: + +```bash +npm init docusaurus@latest my-website classic +``` + +You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. + +The command also installs all necessary dependencies you need to run Docusaurus. + +## Start your site + +Run the development server: + +```bash +cd my-website +npm run start +``` + +The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. + +The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. + +Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/docs/hw-products/wmbus-gateways/gw-v2/_category_.json b/docs/hw-products/wmbus-gateways/gw-v2/_category_.json new file mode 100644 index 00000000..01a25069 --- /dev/null +++ b/docs/hw-products/wmbus-gateways/gw-v2/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Gateway V2", + "position": 7, + "link": { + "type": "generated-index", + "description": "Wireless M-BUS Gateways" + } +} diff --git a/docs/hw-products/wmbus-gateways/gw-v2/description.md b/docs/hw-products/wmbus-gateways/gw-v2/description.md new file mode 100644 index 00000000..ec54b8d9 --- /dev/null +++ b/docs/hw-products/wmbus-gateways/gw-v2/description.md @@ -0,0 +1,47 @@ +--- +sidebar_position: 1 +--- +:::warning +This product has been discontinued and functionally replaced by the wMBUS gateway V3 / V4. +::: +# Description + +## Getting Started + +Get started by **creating a new site**. + +Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. + +### What you'll need + +- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: + - When installing Node.js, you are recommended to check all checkboxes related to dependencies. + +## Generate a new site + +Generate a new Docusaurus site using the **classic template**. + +The classic template will automatically be added to your project after you run the command: + +```bash +npm init docusaurus@latest my-website classic +``` + +You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. + +The command also installs all necessary dependencies you need to run Docusaurus. + +## Start your site + +Run the development server: + +```bash +cd my-website +npm run start +``` + +The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. + +The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. + +Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/docs/hw-products/wmbus-gateways/gw-v3/_category_.json b/docs/hw-products/wmbus-gateways/gw-v3/_category_.json new file mode 100644 index 00000000..e686be85 --- /dev/null +++ b/docs/hw-products/wmbus-gateways/gw-v3/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Gateway V3", + "position": 2, + "link": { + "type": "generated-index", + "description": "Wireless M-BUS Gateways" + } +} diff --git a/docs/hw-products/wmbus-gateways/gw-v3/description.md b/docs/hw-products/wmbus-gateways/gw-v3/description.md new file mode 100644 index 00000000..ec54b8d9 --- /dev/null +++ b/docs/hw-products/wmbus-gateways/gw-v3/description.md @@ -0,0 +1,47 @@ +--- +sidebar_position: 1 +--- +:::warning +This product has been discontinued and functionally replaced by the wMBUS gateway V3 / V4. +::: +# Description + +## Getting Started + +Get started by **creating a new site**. + +Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. + +### What you'll need + +- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: + - When installing Node.js, you are recommended to check all checkboxes related to dependencies. + +## Generate a new site + +Generate a new Docusaurus site using the **classic template**. + +The classic template will automatically be added to your project after you run the command: + +```bash +npm init docusaurus@latest my-website classic +``` + +You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. + +The command also installs all necessary dependencies you need to run Docusaurus. + +## Start your site + +Run the development server: + +```bash +cd my-website +npm run start +``` + +The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. + +The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. + +Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/docs/hw-products/wmbus-gateways/gw-v4/_category_.json b/docs/hw-products/wmbus-gateways/gw-v4/_category_.json new file mode 100644 index 00000000..7ec54697 --- /dev/null +++ b/docs/hw-products/wmbus-gateways/gw-v4/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Gateway V4", + "position": 1, + "link": { + "type": "generated-index", + "description": "Wireless M-BUS Gateway V4" + } +} diff --git a/docs/hw-products/wmbus-gateways/gw-v4/description.md b/docs/hw-products/wmbus-gateways/gw-v4/description.md new file mode 100644 index 00000000..ec54b8d9 --- /dev/null +++ b/docs/hw-products/wmbus-gateways/gw-v4/description.md @@ -0,0 +1,47 @@ +--- +sidebar_position: 1 +--- +:::warning +This product has been discontinued and functionally replaced by the wMBUS gateway V3 / V4. +::: +# Description + +## Getting Started + +Get started by **creating a new site**. + +Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. + +### What you'll need + +- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: + - When installing Node.js, you are recommended to check all checkboxes related to dependencies. + +## Generate a new site + +Generate a new Docusaurus site using the **classic template**. + +The classic template will automatically be added to your project after you run the command: + +```bash +npm init docusaurus@latest my-website classic +``` + +You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. + +The command also installs all necessary dependencies you need to run Docusaurus. + +## Start your site + +Run the development server: + +```bash +cd my-website +npm run start +``` + +The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. + +The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. + +Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/docs/hw-products/wmbus-gateways/intro.md b/docs/hw-products/wmbus-gateways/intro.md new file mode 100644 index 00000000..5c7d52f3 --- /dev/null +++ b/docs/hw-products/wmbus-gateways/intro.md @@ -0,0 +1,74 @@ +--- +sidebar_position: 0 +--- + +# Overview + +
+ > Some notable things in a block quote! +
+ +
+ + + + + + + + + + + + + + + +
Person 1Person 2Person 3
EmilTobiasLinus
161410
+# Tutorial Intro + +|Foo|Bar| +|---|---| +|A|B| + +Let's discover **Docusaurus in less than 5 minutes**. + +## Getting Started + +Get started by **creating a new site**. + +Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. + +### What you'll need + +- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: + - When installing Node.js, you are recommended to check all checkboxes related to dependencies. + +## Generate a new site + +Generate a new Docusaurus site using the **classic template**. + +The classic template will automatically be added to your project after you run the command: + +```bash +npm init docusaurus@latest my-website classic +``` + +You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. + +The command also installs all necessary dependencies you need to run Docusaurus. + +## Start your site + +Run the development server: + +```bash +cd my-website +npm run start +``` + +The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. + +The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. + +Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/docs/hw-products/wmbus-gateways/sun-v1/_category_.json b/docs/hw-products/wmbus-gateways/sun-v1/_category_.json new file mode 100644 index 00000000..de8df6d1 --- /dev/null +++ b/docs/hw-products/wmbus-gateways/sun-v1/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Solar Gateway V1", + "position": 5, + "link": { + "type": "generated-index", + "description": "Wireless M-BUS Gateways" + } +} diff --git a/docs/hw-products/wmbus-gateways/sun-v1/description.md b/docs/hw-products/wmbus-gateways/sun-v1/description.md new file mode 100644 index 00000000..ec54b8d9 --- /dev/null +++ b/docs/hw-products/wmbus-gateways/sun-v1/description.md @@ -0,0 +1,47 @@ +--- +sidebar_position: 1 +--- +:::warning +This product has been discontinued and functionally replaced by the wMBUS gateway V3 / V4. +::: +# Description + +## Getting Started + +Get started by **creating a new site**. + +Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. + +### What you'll need + +- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: + - When installing Node.js, you are recommended to check all checkboxes related to dependencies. + +## Generate a new site + +Generate a new Docusaurus site using the **classic template**. + +The classic template will automatically be added to your project after you run the command: + +```bash +npm init docusaurus@latest my-website classic +``` + +You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. + +The command also installs all necessary dependencies you need to run Docusaurus. + +## Start your site + +Run the development server: + +```bash +cd my-website +npm run start +``` + +The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. + +The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. + +Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/docs/knowledge-base/_category_.json b/docs/knowledge-base/_category_.json new file mode 100644 index 00000000..ca260e0a --- /dev/null +++ b/docs/knowledge-base/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Knowledge Base", + "position": 1, + "link": { + "type": "generated-index", + "description": "Knowledge Base related to Lobaro Products" + } +} diff --git a/docs/knowledge-base/intro.md b/docs/knowledge-base/intro.md new file mode 100644 index 00000000..646d4408 --- /dev/null +++ b/docs/knowledge-base/intro.md @@ -0,0 +1,72 @@ +--- +sidebar_position: 3 +--- + +
+ > Some notable things in a block quote! +
+ +
+ + + + + + + + + + + + + + + +
Person 1Person 2Person 3
EmilTobiasLinus
161410
+# Tutorial Intro + +|Foo|Bar| +|---|---| +|A|B| + +Let's discover **Docusaurus in less than 5 minutes**. + +## Getting Started + +Get started by **creating a new site**. + +Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. + +### What you'll need + +- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: + - When installing Node.js, you are recommended to check all checkboxes related to dependencies. + +## Generate a new site + +Generate a new Docusaurus site using the **classic template**. + +The classic template will automatically be added to your project after you run the command: + +```bash +npm init docusaurus@latest my-website classic +``` + +You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. + +The command also installs all necessary dependencies you need to run Docusaurus. + +## Start your site + +Run the development server: + +```bash +cd my-website +npm run start +``` + +The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. + +The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. + +Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/docs/platform/_category_.json b/docs/platform/_category_.json new file mode 100644 index 00000000..40cbb1cd --- /dev/null +++ b/docs/platform/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "Lobaro Platform", + "position": 2, + "collapsed": true, + "link": { + "type": "generated-index", + "description": "Lobaro IoT Platform" + } +} diff --git a/docs/intro.md b/docs/platform/platform.md similarity index 94% rename from docs/intro.md rename to docs/platform/platform.md index 45e8604c..645d0f72 100644 --- a/docs/intro.md +++ b/docs/platform/platform.md @@ -2,9 +2,8 @@ sidebar_position: 1 --- -# Tutorial Intro +# Platform Features -Let's discover **Docusaurus in less than 5 minutes**. ## Getting Started diff --git a/docs/tutorial-basics/_category_.json b/docs/tutorial-basics/_category_.json index 2e6db55b..40e3530a 100644 --- a/docs/tutorial-basics/_category_.json +++ b/docs/tutorial-basics/_category_.json @@ -1,6 +1,6 @@ { "label": "Tutorial - Basics", - "position": 2, + "position": 3, "link": { "type": "generated-index", "description": "5 minutes to learn the most important Docusaurus concepts." diff --git a/docs/tutorial-extras/_category_.json b/docs/tutorial-extras/_category_.json index a8ffcc19..832c3d1e 100644 --- a/docs/tutorial-extras/_category_.json +++ b/docs/tutorial-extras/_category_.json @@ -1,6 +1,6 @@ { "label": "Tutorial - Extras", - "position": 3, + "position": 4, "link": { "type": "generated-index" } diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 10c70006..417e75ee 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -68,11 +68,30 @@ const config: Config = { width: '100px' }, items: [ + /* { type: 'docSidebar', - sidebarId: 'tutorialSidebar', + sidebarId: 'productsSidebar', position: 'left', - label: 'Tutorial', + label: 'All Products', + },*/ + { + type: 'docSidebar', + sidebarId: 'wmbusGwSidebar', + position: 'left', + label: 'Wireless M-BUS Gateways', + }, + { + type: 'docSidebar', + sidebarId: 'platformSidebar', + position: 'left', + label: 'IoT Platform', + }, + { + type: 'docSidebar', + sidebarId: 'knowledgeBaseSidebar', + position: 'right', + label: 'Knowledge Base', }, /* {to: '/blog', label: 'Blog', position: 'left'},*/ { diff --git a/sidebars.ts b/sidebars.ts index acc7685a..6bcfee78 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -10,9 +10,46 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; Create as many sidebars as you want. */ +// https://docusaurus.io/docs/sidebar/autogenerated + const sidebars: SidebarsConfig = { // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + knowledgeBaseSidebar: [{type: 'autogenerated', dirName: 'knowledge-base'}], + //productsSidebar: [{type: 'autogenerated', dirName: '.'}], + productsSidebar: [ + { + type: 'category', + label: 'Hardware Products', + items: [ + {type: 'autogenerated', dirName: 'hw-products'}, + ], + }, + { + type: 'category', + label: 'Lobaro Platform', + items: [ + {type: 'autogenerated', dirName: 'platform'}, + ], + }, + ], + wmbusGwSidebar: [ + { + type: 'category', + label: 'Wireless M-BUS Gateways', + items: [ + {type: 'autogenerated', dirName: 'hw-products/wmbus-gateways'}, + ], + }, + ], + platformSidebar: [ + { + type: 'category', + label: 'IoT Platform', + items: [ + {type: 'autogenerated', dirName: 'platform'}, + ], + }, + ], // But you can create a sidebar manually /*