Skip to content

Commit b870e34

Browse files
committed
Fix example URLs in TheThingsNetwork documentation
The ABP and OTAA examples links were no longer correct, also replaced all absolute Github URLs with relative ones so they work as expected in forked or offline repositories.
1 parent dd65459 commit b870e34

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
We'd ❤️ to welcome your contribution. Please make sure your changes include:
44

55
1. Examples: [examples](examples)
6-
2. Syntax highlighting: [keywords.txt](../keywords.txt)
6+
2. Syntax highlighting: [keywords.txt](keywords.txt)
77
3. Documentation: [docs](docs)
88
4. Tests: [test](test)
99
5. Verification of the examples and tests: [.travis.yml](.travis.yml)

docs/TheThingsNetwork.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ RX Delay 1: 1000
6464
RX Delay 2: 2000
6565
```
6666

67-
See the [DeviceInfo](https://github.com/TheThingsNetwork/arduino-device-lib/blob/master/examples/DeviceInfo/DeviceInfo.ino) example.
67+
See the [DeviceInfo](../examples/DeviceInfo/DeviceInfo.ino) example.
6868

6969
## Method: `onMessage`
7070

@@ -78,7 +78,7 @@ void onMessage(void (*cb)(const byte* payload, size_t length, port_t port));
7878
- `size_t length`: Number of bytes.
7979
- `port_t port`: The port addressed.
8080
81-
See the [Receive](https://github.com/TheThingsNetwork/arduino-device-lib/blob/master/examples/Receive/Receive.ino) example.
81+
See the [Receive](../examples/Receive/Receive.ino) example.
8282
8383
## Method: `join`
8484
@@ -115,7 +115,7 @@ Returns `true` or `false` depending on whether the activation was successful.
115115
116116
Call the method with no arguments if the device's LoRa module comes with pre-flashed values.
117117
118-
See the [ABP](https://github.com/TheThingsNetwork/arduino-device-lib/blob/master/examples/ABP/ABP.ino) example.
118+
See the [SendABP](../examples/SendABP/SendABP.ino) example.
119119
120120
## Method: `sendBytes`
121121
@@ -138,7 +138,7 @@ Returns a success or error code and logs the related error message:
138138
* `TTN_SUCCESSFUL_RECEIVE`: Successful transmission. Received \<N> bytes
139139
* `TTN_ERROR_UNEXPECTED_RESPONSE`: Unexpected response: \<Response>
140140

141-
See the [Send](https://github.com/TheThingsNetwork/arduino-device-lib/blob/master/examples/Send/Send.ino) example.
141+
See the [SendOTAA](../examples/SendOTAA/SendOTAA.ino) example.
142142

143143
## Method: `poll`
144144

@@ -153,7 +153,7 @@ int8_t poll(port_t port = 1, bool confirm = false);
153153
154154
Returns the result of `sendBytes()`.
155155
156-
See the [Receive](https://github.com/TheThingsNetwork/arduino-device-lib/blob/master/examples/Receive/Receive.ino) example.
156+
See the [Receive](../examples/Receive/Receive.ino) example.
157157
158158
## Method: `provision`
159159
@@ -217,4 +217,3 @@ Returns the voltage in millivolt (mV) measured by the RN2xxx LoRa module. It's f
217217
```c
218218
uint16_t getVDD();
219219
```
220-

0 commit comments

Comments
 (0)