Skip to content

Commit

Permalink
Merge pull request #38 from TheThingsIndustries/docs/links-fixes
Browse files Browse the repository at this point in the history
doc: Update links to markdown format, add a minor UART connection fix
  • Loading branch information
elsalahy authored Oct 7, 2021
2 parents 5461451 + 7960f5a commit c2d91eb
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions doc/content/getting-started/programming-software/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ The wiring from the ST-LINK/V3 programmer → {{% gnse %}} is as follows:

Optionally you can connect RX and TX pins to work with UART (either for sending and receiving messages or programming).

6. RX → TX
7. TX → RX
6. RX → RX (Only with ST-LINK boards, other boards would be RX → TX)
7. TX → TX (Only with ST-LINK boards, other boards would be TX → RX)

{{< warning >}} Be careful not to mix VCC with VIN pin on the {{% gnse %}}. VIN should still be powered separately, either with the pin or the battery connector, as it powers the {{% gnse %}}. VCC is used as target voltage indicator. {{</ warning >}}

Expand Down
4 changes: 2 additions & 2 deletions doc/content/getting-started/se-hw/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Get started by becoming familiar with the {{% gnse %}} on-board peripherals and

## Working with the Generic Node Sensor Edition Repository

It is always a good idea to get familiar with the available HW design files. Check out the <a href="https://github.com/TheThingsIndustries/generic-node-se" target="_blank">{{% gnse %}} on Github</a> to get familiar with the repository structure.
It is always a good idea to get familiar with the available HW design files. Check out the [Generic Node Sensor Edition Github repository](https://github.com/TheThingsIndustries/generic-node-se) to get familiar with the repository structure.

Next, clone the repository to get its local copy on your machine by running the following command:

Expand All @@ -21,7 +21,7 @@ $ git clone --branch develop \
https://github.com/TheThingsIndustries/generic-node-se.git
```

If you are not too familiar with Git, visit the official GitHub documentation to <a href="https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/cloning-a-repository" target="_blank">learn to clone a repository</a>.
If you are not too familiar with Git, visit the official [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/cloning-a-repository) to learn how to clone a repository.

## Becoming familiar with the Generic Node Sensor Edition Board

Expand Down
4 changes: 2 additions & 2 deletions doc/content/getting-started/se-sw/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Get started by installing all the tools needed and setting up your environment t

## Working with the Generic Node Sensor Edition Repository

It is always a good idea to get familiar with the available source code and the applications that are compatible with your board. Check out the <a href="https://github.com/TheThingsIndustries/generic-node-se" target="_blank">{{% gnse %}} on Github</a> to get familiar with the repository structure.
It is always a good idea to get familiar with the available source code and the applications that are compatible with your board. Check out the [Generic Node Sensor Edition Github repository](https://github.com/TheThingsIndustries/generic-node-se) to get familiar with the repository structure.

Next, clone the repository to get its local copy on your machine by running the following command:

Expand All @@ -20,6 +20,6 @@ $ git clone --branch develop \
--recurse-submodules \
https://github.com/TheThingsIndustries/generic-node-se.git
```
If you are not too familiar with Git, visit the official GitHub documentation to <a href="https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/cloning-a-repository" target="_blank">learn to clone a repository</a>.
If you are not too familiar with Git, visit the official [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/cloning-a-repository) to learn how to clone a repository</a>.

If you are planning to develop custom applications and/or contribute to the source code, see the [Environment setup]({{< ref "/getting-started/se-sw/env-setup" >}}) guide.
8 changes: 4 additions & 4 deletions doc/content/sensor-edition/beta-welcome/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,16 @@ The [Getting started]({{< ref "/getting-started" >}}) is a great place to get fa

## Where to contribute?

We use the <a href="https://github.com/TheThingsIndustries/generic-node-se" target="_blank">{{% gnse %}} Github repository</a> in our development. You can <a href="https://github.com/TheThingsIndustries/generic-node-se/issues/new/choose" target="_blank">file an issue</a> to request a feature or report a bug.
We use the [Generic Node Sensor Edition Github repository](https://github.com/TheThingsIndustries/generic-node-se) in our development. You can [file an issue](https://github.com/TheThingsIndustries/generic-node-se/issues/new/choose) to request a feature or report a bug.

The <a href="https://www.thethingsnetwork.org/forum/c/nodes/generic-node" target="_blank">{{% gn %}} Forum</a> is where we will have discussions and where you can provide feedback.
The [Generic Node Forum](https://www.thethingsnetwork.org/forum/c/nodes/generic-node) is where we will have discussions and where you can provide feedback.
You will be added to a private group with other Beta developers.

## Things to try

We will send you a couple of emails to assist you with trying-out some cool things that are only possible with the {{% gnse %}} like:
- <a href="https://www.thethingsindustries.com/docs/devices/device-claiming/claim-devices/" target="_blank">QR code claiming</a>
- <a href="https://www.thethingsindustries.com/docs/devices/claim-atecc608a/" target="_blank">Secure element claiming </a>
- [QR code claiming](https://www.thethingsindustries.com/docs/devices/device-claiming/claim-devices/)
- [Secure element claiming](https://www.thethingsindustries.com/docs/devices/claim-atecc608a/)
- Adding external sensors
- Using FreeRTOS with LoRaWAN
- Using TinyML with LoRaWAN
Expand Down

0 comments on commit c2d91eb

Please sign in to comment.