From cc769197521bd03d7696646a384339393bd69f62 Mon Sep 17 00:00:00 2001 From: Sacha Weatherstone Date: Mon, 12 Apr 2021 10:08:40 +1000 Subject: [PATCH 1/2] update protobufs --- protobufs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/protobufs b/protobufs index 5cb09ec9..ff66c549 160000 --- a/protobufs +++ b/protobufs @@ -1 +1 @@ -Subproject commit 5cb09ec96321ce0cfae18141e5da3b75e001c9fe +Subproject commit ff66c549498052a1a3cf75f8ad1a66a4adcdc413 From 912213f1f147722009da5df91ca483dbc7bd8edb Mon Sep 17 00:00:00 2001 From: Sacha Weatherstone Date: Mon, 12 Apr 2021 11:29:30 +1000 Subject: [PATCH 2/2] Finish base scaffolding --- .github/workflows/ci.yml | 2 +- website/docs/developers/api.md | 2 +- .../docs/{ => developers}/device/documents.md | 0 website/docs/{ => developers}/device/faq.md | 0 .../docs/{ => developers}/device/http-api.md | 0 .../{ => developers}/device/radio-settings.md | 0 .../device/supported-hardware.md | 0 website/docs/developers/overview.md | 6 +++ .../docs/{ => developers}/protobufs/api.md | 0 website/docs/getting_started/concepts.md | 2 +- .../docs/getting_started/flashing_firmware.md | 2 +- website/docs/getting_started/overview.md | 4 +- website/docs/hardware/antenna.md | 2 +- website/docs/hardware/behaviour.md | 2 +- website/docs/hardware/overview.md | 6 +++ website/docs/hardware/supported_hardware.md | 2 +- website/docs/{ => software}/js/connecting.md | 0 website/docs/{ => software}/js/events.md | 0 .../docs/{ => software}/js/getting-started.md | 0 website/docs/{ => software}/js/http-api.md | 0 website/docs/software/overview.md | 3 +- website/docusaurus.config.js | 14 +++--- website/sidebars.js | 45 ++++++++++--------- 23 files changed, 54 insertions(+), 38 deletions(-) rename website/docs/{ => developers}/device/documents.md (100%) rename website/docs/{ => developers}/device/faq.md (100%) rename website/docs/{ => developers}/device/http-api.md (100%) rename website/docs/{ => developers}/device/radio-settings.md (100%) rename website/docs/{ => developers}/device/supported-hardware.md (100%) create mode 100644 website/docs/developers/overview.md rename website/docs/{ => developers}/protobufs/api.md (100%) create mode 100644 website/docs/hardware/overview.md rename website/docs/{ => software}/js/connecting.md (100%) rename website/docs/{ => software}/js/events.md (100%) rename website/docs/{ => software}/js/getting-started.md (100%) rename website/docs/{ => software}/js/http-api.md (100%) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 9d065bf5..f2165a74 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -18,7 +18,7 @@ jobs: with: submodules: true - name: Generate protobuf docs - run: protoc --doc_out="website/docs/protobufs" --doc_opt="./website/protobuf.tmpl,api.md" --proto_path="protobufs" protobufs/*.proto + run: protoc --doc_out="website/docs/developers/protobufs" --doc_opt="./website/protobuf.tmpl,api.md" --proto_path="protobufs" protobufs/*.proto - uses: amondnet/vercel-action@v20 with: vercel-token: ${{ secrets.VERCEL_TOKEN }} diff --git a/website/docs/developers/api.md b/website/docs/developers/api.md index ed35e902..e192f826 100644 --- a/website/docs/developers/api.md +++ b/website/docs/developers/api.md @@ -1,5 +1,5 @@ --- -id: api_developers +id: api title: APIs sidebar_label: APIs --- diff --git a/website/docs/device/documents.md b/website/docs/developers/device/documents.md similarity index 100% rename from website/docs/device/documents.md rename to website/docs/developers/device/documents.md diff --git a/website/docs/device/faq.md b/website/docs/developers/device/faq.md similarity index 100% rename from website/docs/device/faq.md rename to website/docs/developers/device/faq.md diff --git a/website/docs/device/http-api.md b/website/docs/developers/device/http-api.md similarity index 100% rename from website/docs/device/http-api.md rename to website/docs/developers/device/http-api.md diff --git a/website/docs/device/radio-settings.md b/website/docs/developers/device/radio-settings.md similarity index 100% rename from website/docs/device/radio-settings.md rename to website/docs/developers/device/radio-settings.md diff --git a/website/docs/device/supported-hardware.md b/website/docs/developers/device/supported-hardware.md similarity index 100% rename from website/docs/device/supported-hardware.md rename to website/docs/developers/device/supported-hardware.md diff --git a/website/docs/developers/overview.md b/website/docs/developers/overview.md new file mode 100644 index 00000000..125d13c3 --- /dev/null +++ b/website/docs/developers/overview.md @@ -0,0 +1,6 @@ +--- +id: overview +title: Overview +sidebar_label: Overview +slug: /developers +--- diff --git a/website/docs/protobufs/api.md b/website/docs/developers/protobufs/api.md similarity index 100% rename from website/docs/protobufs/api.md rename to website/docs/developers/protobufs/api.md diff --git a/website/docs/getting_started/concepts.md b/website/docs/getting_started/concepts.md index 4051b01d..aad58c40 100644 --- a/website/docs/getting_started/concepts.md +++ b/website/docs/getting_started/concepts.md @@ -1,5 +1,5 @@ --- -id: concepts_getting_started +id: concepts title: Concepts sidebar_label: Concepts slug: /getting_started/concepts diff --git a/website/docs/getting_started/flashing_firmware.md b/website/docs/getting_started/flashing_firmware.md index adba2cce..ea2ccf4d 100644 --- a/website/docs/getting_started/flashing_firmware.md +++ b/website/docs/getting_started/flashing_firmware.md @@ -1,5 +1,5 @@ --- -id: flashing_firmware_getting_started +id: flashing_firmware title: Flashing Firmware sidebar_label: Flashing slug: /getting_started/flashing_firmware diff --git a/website/docs/getting_started/overview.md b/website/docs/getting_started/overview.md index 07cdc186..419ee2c0 100644 --- a/website/docs/getting_started/overview.md +++ b/website/docs/getting_started/overview.md @@ -1,5 +1,5 @@ --- -id: overview_getting_started +id: overview title: What is Meshtastic? sidebar_label: Overview slug: /getting_started @@ -97,4 +97,4 @@ For a nice looking cases: ## IMPORTANT DISCLAIMERS AND FAQ -For a listing of currently missing features and a FAQ click [here](device/faq). +For a listing of currently missing features and a FAQ click [here](developers/device/faq). diff --git a/website/docs/hardware/antenna.md b/website/docs/hardware/antenna.md index 9a4f53b3..c00f1dad 100644 --- a/website/docs/hardware/antenna.md +++ b/website/docs/hardware/antenna.md @@ -1,5 +1,5 @@ --- -id: antenna_hardware +id: antenna title: Antennas sidebar_label: Antennas slug: /hardware/antenna diff --git a/website/docs/hardware/behaviour.md b/website/docs/hardware/behaviour.md index d510d3e4..09d78e29 100644 --- a/website/docs/hardware/behaviour.md +++ b/website/docs/hardware/behaviour.md @@ -1,5 +1,5 @@ --- -id: behaviour_hardware +id: behaviour title: Button Behaviour sidebar_label: Behaviour slug: /hardware/behaviour diff --git a/website/docs/hardware/overview.md b/website/docs/hardware/overview.md new file mode 100644 index 00000000..aa3a641e --- /dev/null +++ b/website/docs/hardware/overview.md @@ -0,0 +1,6 @@ +--- +id: overview +title: Overview +sidebar_label: Overview +slug: /hardware +--- diff --git a/website/docs/hardware/supported_hardware.md b/website/docs/hardware/supported_hardware.md index dd2d23a0..389c3bb8 100644 --- a/website/docs/hardware/supported_hardware.md +++ b/website/docs/hardware/supported_hardware.md @@ -1,5 +1,5 @@ --- -id: supported_hardware_hardware +id: supported_hardware title: Supported hardware sidebar_label: Supported hardware slug: /hardware/supported_hardware diff --git a/website/docs/js/connecting.md b/website/docs/software/js/connecting.md similarity index 100% rename from website/docs/js/connecting.md rename to website/docs/software/js/connecting.md diff --git a/website/docs/js/events.md b/website/docs/software/js/events.md similarity index 100% rename from website/docs/js/events.md rename to website/docs/software/js/events.md diff --git a/website/docs/js/getting-started.md b/website/docs/software/js/getting-started.md similarity index 100% rename from website/docs/js/getting-started.md rename to website/docs/software/js/getting-started.md diff --git a/website/docs/js/http-api.md b/website/docs/software/js/http-api.md similarity index 100% rename from website/docs/js/http-api.md rename to website/docs/software/js/http-api.md diff --git a/website/docs/software/overview.md b/website/docs/software/overview.md index 3183c63c..11a1a749 100644 --- a/website/docs/software/overview.md +++ b/website/docs/software/overview.md @@ -1,5 +1,6 @@ --- -id: overview-software +id: overview title: Overview sidebar_label: Overview +slug: /software --- diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 70efafa0..bd43e184 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -27,19 +27,19 @@ module.exports = { position: "left", }, { - to: "docs/software/overview-software", + to: "docs/software", activeBasePath: "docs/software", label: "Software", position: "left", }, { - to: "docs/hardware/supported_hardware", + to: "docs/hardware", activeBasePath: "docs/hardware", label: "Hardware", position: "left", }, { - to: "docs/developers/api_developers", + to: "docs/developers", activeBasePath: "docs/developers", label: "Developers", position: "left", @@ -69,15 +69,15 @@ module.exports = { }, { label: "Software", - to: "docs/software/overview-software", + to: "docs/software", }, { label: "Hardware", - to: "docs/hardware/supported_hardware", + to: "docs/hardware", }, { label: "Developers", - to: "docs/developers/api_developers", + to: "docs/developers", }, ], }, @@ -90,7 +90,7 @@ module.exports = { }, { label: "Slack", - href: "#", + href: "https://meshtasticdev.slack.com", }, ], }, diff --git a/website/sidebars.js b/website/sidebars.js index fbdb27ef..fa4bb594 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -1,24 +1,24 @@ module.exports = { Sidebar: { "Getting Started": [ - "getting_started/overview_getting_started", - "getting_started/flashing_firmware_getting_started", - "getting_started/concepts_getting_started", + "getting_started/overview", + "getting_started/flashing_firmware", + "getting_started/concepts", { "Howto's": [], }, ], Software: [ - "software/overview-software", + "software/overview", { "Meshtastic Android": [], }, { "Meshtastic.js": [ - "js/getting-started", - "js/connecting", - "js/events", - "js/http-api", + "software/js/getting-started", + "software/js/connecting", + "software/js/events", + "software/js/http-api", { type: "link", label: "API Docs", @@ -56,23 +56,26 @@ module.exports = { }, ], Hardware: [ - "hardware/supported_hardware_hardware", - "hardware/behaviour_hardware", - "hardware/antenna_hardware", + "hardware/overview", + "hardware/supported_hardware", + "hardware/behaviour", + "hardware/antenna", ], Developers: [ + "developers/overview", { - Protobufs: ["protobufs/api"], + Protobufs: ["developers/protobufs/api"], + }, + "developers/api", + { + Device: [ + "developers/device/radio-settings", + "developers/device/supported-hardware", + "developers/device/faq", + "developers/device/http-api", + "developers/device/documents", + ], }, - "developers/api_developers", - ], - - Device: [ - "device/radio-settings", - "device/supported-hardware", - "device/faq", - "device/http-api", - "device/documents", ], }, };