Finish base scaffolding

This commit is contained in:
Sacha Weatherstone 2021-04-12 11:29:30 +10:00
parent cc76919752
commit 912213f1f1
23 changed files with 54 additions and 38 deletions

View file

@ -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 }}

View file

@ -1,5 +1,5 @@
---
id: api_developers
id: api
title: APIs
sidebar_label: APIs
---

View file

@ -0,0 +1,6 @@
---
id: overview
title: Overview
sidebar_label: Overview
slug: /developers
---

View file

@ -1,5 +1,5 @@
---
id: concepts_getting_started
id: concepts
title: Concepts
sidebar_label: Concepts
slug: /getting_started/concepts

View file

@ -1,5 +1,5 @@
---
id: flashing_firmware_getting_started
id: flashing_firmware
title: Flashing Firmware
sidebar_label: Flashing
slug: /getting_started/flashing_firmware

View file

@ -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).

View file

@ -1,5 +1,5 @@
---
id: antenna_hardware
id: antenna
title: Antennas
sidebar_label: Antennas
slug: /hardware/antenna

View file

@ -1,5 +1,5 @@
---
id: behaviour_hardware
id: behaviour
title: Button Behaviour
sidebar_label: Behaviour
slug: /hardware/behaviour

View file

@ -0,0 +1,6 @@
---
id: overview
title: Overview
sidebar_label: Overview
slug: /hardware
---

View file

@ -1,5 +1,5 @@
---
id: supported_hardware_hardware
id: supported_hardware
title: Supported hardware
sidebar_label: Supported hardware
slug: /hardware/supported_hardware

View file

@ -1,5 +1,6 @@
---
id: overview-software
id: overview
title: Overview
sidebar_label: Overview
slug: /software
---

View file

@ -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",
},
],
},

View file

@ -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_developers",
],
"developers/api",
{
Device: [
"device/radio-settings",
"device/supported-hardware",
"device/faq",
"device/http-api",
"device/documents",
"developers/device/radio-settings",
"developers/device/supported-hardware",
"developers/device/faq",
"developers/device/http-api",
"developers/device/documents",
],
},
],
},
};