mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-12-24 21:24:44 -08:00
Finish base scaffolding
This commit is contained in:
parent
cc76919752
commit
912213f1f1
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
|
@ -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 }}
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: api_developers
|
||||
id: api
|
||||
title: APIs
|
||||
sidebar_label: APIs
|
||||
---
|
||||
|
|
6
website/docs/developers/overview.md
Normal file
6
website/docs/developers/overview.md
Normal file
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: overview
|
||||
title: Overview
|
||||
sidebar_label: Overview
|
||||
slug: /developers
|
||||
---
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: concepts_getting_started
|
||||
id: concepts
|
||||
title: Concepts
|
||||
sidebar_label: Concepts
|
||||
slug: /getting_started/concepts
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: flashing_firmware_getting_started
|
||||
id: flashing_firmware
|
||||
title: Flashing Firmware
|
||||
sidebar_label: Flashing
|
||||
slug: /getting_started/flashing_firmware
|
||||
|
|
|
@ -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).
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: antenna_hardware
|
||||
id: antenna
|
||||
title: Antennas
|
||||
sidebar_label: Antennas
|
||||
slug: /hardware/antenna
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: behaviour_hardware
|
||||
id: behaviour
|
||||
title: Button Behaviour
|
||||
sidebar_label: Behaviour
|
||||
slug: /hardware/behaviour
|
||||
|
|
6
website/docs/hardware/overview.md
Normal file
6
website/docs/hardware/overview.md
Normal file
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: overview
|
||||
title: Overview
|
||||
sidebar_label: Overview
|
||||
slug: /hardware
|
||||
---
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
id: supported_hardware_hardware
|
||||
id: supported_hardware
|
||||
title: Supported hardware
|
||||
sidebar_label: Supported hardware
|
||||
slug: /hardware/supported_hardware
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
id: overview-software
|
||||
id: overview
|
||||
title: Overview
|
||||
sidebar_label: Overview
|
||||
slug: /software
|
||||
---
|
||||
|
|
|
@ -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",
|
||||
},
|
||||
],
|
||||
},
|
||||
|
|
|
@ -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",
|
||||
],
|
||||
},
|
||||
};
|
||||
|
|
Loading…
Reference in a new issue