summaryrefslogtreecommitdiff
path: root/docs/reference/getting_started.rst
diff options
context:
space:
mode:
authorHiFiPhile <[email protected]>2025-10-11 16:53:35 +0200
committerHiFiPhile <[email protected]>2025-10-11 16:53:35 +0200
commitb9b1c6432a7be43297afb0a75621ece5fc63f3a5 (patch)
treecd7639e4b3a5782fb78f20a3b96f24d69577508c /docs/reference/getting_started.rst
parente0a589cdcae6eaf790d05712a6f2b8c0352fb5fd (diff)
parent2e29d1c60d119b2aa71e36d0c1ac2a383e333076 (diff)
Merge branch 'master' into dwc2_iso_incomp
Diffstat (limited to 'docs/reference/getting_started.rst')
-rw-r--r--docs/reference/getting_started.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/reference/getting_started.rst b/docs/reference/getting_started.rst
index bb9ff1cb4..b891d911b 100644
--- a/docs/reference/getting_started.rst
+++ b/docs/reference/getting_started.rst
@@ -50,7 +50,7 @@ To incorporate tinyusb to your project
Examples
--------
-For your convenience, TinyUSB contains a handful of examples for both host and device with/without RTOS to quickly test the functionality as well as demonstrate how API should be used. Most examples will work on most of `the supported boards <boards.rst>`_. Firstly we need to ``git clone`` if not already
+For your convenience, TinyUSB contains a handful of examples for both host and device with/without RTOS to quickly test the functionality as well as demonstrate how API should be used. Most examples will work on most of :doc:`the supported boards <boards>`. Firstly we need to ``git clone`` if not already
.. code-block:: bash
@@ -77,7 +77,7 @@ The hardware code is located in ``hw/bsp`` folder, and is organized by family/bo
$ cd examples/device/cdc_msc
$ make BOARD=feather_nrf52840_express get-deps
-You only need to do this once per family. Check out `complete list of dependencies and their designated path here <dependencies.rst>`_
+You only need to do this once per family. Check out :doc:`complete list of dependencies and their designated path here <dependencies>`
Build Examples
^^^^^^^^^^^^^^
@@ -178,7 +178,7 @@ By default log message is printed via on-board UART which is slow and take lots
* Pros: work with most if not all MCUs
* Software viewer is JLink RTT Viewer/Client/Logger which is bundled with JLink driver package.
-* ``LOGGER=swo``\ : Use dedicated SWO pin of ARM Cortex SWD debug header.
+* ``LOGGER=swo`` : Use dedicated SWO pin of ARM Cortex SWD debug header.
* Cons: only work with ARM Cortex MCUs minus M0
* Pros: should be compatible with more debugger that support SWO.