From d52e232340306675f3d2e86bd034b1247f6d0d71 Mon Sep 17 00:00:00 2001 From: apt105 <73254487+apt105@users.noreply.github.com> Date: Mon, 17 May 2021 23:15:55 +0100 Subject: [PATCH] fix broken links --- website/docs/developers/device/plugin-api.md | 4 ++-- website/docs/software/other/mqtt.md | 2 +- website/docs/software/other/sw-design.md | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/website/docs/developers/device/plugin-api.md b/website/docs/developers/device/plugin-api.md index 9491134c..e4045dc4 100644 --- a/website/docs/developers/device/plugin-api.md +++ b/website/docs/developers/device/plugin-api.md @@ -41,14 +41,14 @@ A number of [key services](http://github.com/meshtastic/meshtastic-device/tree/m - [TextMessagePlugin](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/TextMessagePlugin.h) - receives text messages and displays them on the LCD screen/stores them in the local DB - [NodeInfoPlugin](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/NodeInfoPlugin.h) - receives/sends User information to other nodes so that usernames are available in the databases -- [RemoteHardwarePlugin](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/RemoteHardwarePlugin.h) - a plugin that provides easy remote access to device hardware (for things like turning GPIOs on or off). Intended to be a more extensive example and provide a useful feature of its own. See [remote-hardware](/docs/software/other/remote-hardware-service.md) for details. +- [RemoteHardwarePlugin](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/RemoteHardwarePlugin.h) - a plugin that provides easy remote access to device hardware (for things like turning GPIOs on or off). Intended to be a more extensive example and provide a useful feature of its own. See [remote-hardware](/docs/software/other/remote-hardware-service) for details. - [ReplyPlugin](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/ReplyPlugin.h) - a simple plugin that just replies to any packet it receives (provides a 'ping' service). ## Getting started The easiest way to get started is: -- [Build and install](/docs/software/other/build-instructions.md) the standard codebase from github. +- [Build and install](/docs/software/other/build-instructions) the standard codebase from github. - Copy [src/plugins/ReplyPlugin.\*](http://github.com/meshtastic/meshtastic-device/tree/master/src/plugins/ReplyPlugin.cpp) into src/plugins/YourPlugin.*. Then change the port number from *PortNum_REPLY_APP* to *PortNum_PRIVATE_APP\*. - Edit plugins/Plugins.cpp:setupPlugins() to add a call to create an instance of your plugin (see comment at head of that function) - Rebuild with your new messaging goodness and install on the device diff --git a/website/docs/software/other/mqtt.md b/website/docs/software/other/mqtt.md index 2bc17fcc..7bc0e5f1 100644 --- a/website/docs/software/other/mqtt.md +++ b/website/docs/software/other/mqtt.md @@ -44,7 +44,7 @@ FIXME - explain this more, talk about how useful for users and security domains. ## On device API -For information on the related on-device API see [here](/doc/developers/device/device-api.md). +For information on the related on-device API see [here](/doc/developers/device/device-api). ## MQTT transport diff --git a/website/docs/software/other/sw-design.md b/website/docs/software/other/sw-design.md index b0127ab7..694e5e8b 100644 --- a/website/docs/software/other/sw-design.md +++ b/website/docs/software/other/sw-design.md @@ -7,9 +7,9 @@ sidebar_label: Software Design This is a mini design doc for developing the meshtastic software. - [Build instructions](build-instructions.md) -- [On device plugin API](/doc/developers/device/plugin-api.md) - a tutorial on how to write small Plugins which run on the device and can message other nodes. +- [On device plugin API](/doc/developers/device/plugin-api) - a tutorial on how to write small Plugins which run on the device and can message other nodes. - Our [project board](https://github.com/orgs/meshtastic/projects/1) - shows what things we are currently working on and remaining work items for the current release. - [Power Management](power.md) -- [Mesh algorithm](/doc/developers/device/mesh-alg.md) -- [External client API](/doc/developers/device/device-api.md) and porting guide for new clients (iOS, python, etc...) +- [Mesh algorithm](/doc/developers/device/mesh-alg) +- [External client API](/doc/developers/device/device-api) and porting guide for new clients (iOS, python, etc...) - TODO: how to port the device code to a new device.