Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Fiber plugin and sidebar configuration #95

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,16 @@ const config = {
],

plugins: [
[
'@docusaurus/plugin-content-docs',
({
id: 'fiber',
path: 'fiber',
routeBasePath: 'fiber',
sidebarPath: require.resolve('./sidebars-fiber.js'),
editUrl: 'https://github.com/hardwario/docs/edit/main'
}),
],
[
'@docusaurus/plugin-content-docs',
({
Expand Down Expand Up @@ -97,6 +107,12 @@ const config = {
position: 'left',
activeBaseRegex: `/chester/`,
},
{
to: '/fiber/',
label: 'FIBER',
position: 'left',
activeBaseRegex: `/fiber/`,
},
{
to: '/ember/',
label: 'EMBER',
Expand Down
13 changes: 10 additions & 3 deletions fiber/mqtt-broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,18 @@ MQTT is an open, simple and low overhead communication protocol for sending mess
- e.g. `+/light/set` will subscribe to `bedroom/light/set`, `kitchen/light/set`, etc.
- `#` wildcard will subscribe to all sub-topics of a specified topic
- e.g. `kitchen/#` will subscribe to `kitchen/light/set`, `kitchen/light/get`, `kitchen/temperature/get`, etc.
caution
:::caution

The wildcard **#** can be used only at the **end of the topic** name

> You can read [**more about the MQTT topics and how to use them**](https://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices/).
:::

:::tip

You can read [**more about the MQTT topics and how to use them**](https://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices/).

:::


## FIBER Topics

Expand Down
8 changes: 7 additions & 1 deletion fiber/troubleshouting.md → fiber/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@ import Image from '@theme/IdealImage';

## 1. Reboot the system using MQTT broker
- **/system/reboot**: Initiates a system reboot.
> You can read [**more about rebooting a system using MQTT here.**](./mqtt-broker)

:::tip

You can read [**more about rebooting a system using MQTT here.**](./mqtt-broker)

:::

## 2. Restart the Device

Expand All @@ -28,6 +33,7 @@ If restarting the device via the button does not resolve the issue, please check
## 4. Reinstall image and run the FIBER

- Follow the installation instructions outlined in section [**FIBER Installation**](./installation-setup) of this documentation.

- Log in to the target

```sh
Expand Down
15 changes: 15 additions & 0 deletions sidebars-fiber.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
docs: [
'introduction',
'installation-setup',
'configuration',
'project-structure',
'mqtt-broker',
'troubleshooting',
],
};

module.exports = sidebars;