Skip to content

Commit 168751a

Browse files
dbkinderioannisg
authored andcommitted
doc: fix broken doc links
The project's README.rst references the support board docs with an URL that's not working these days (see zephyrproject-rtos/infrastructure#134) so fix that URL reference. While looking for other similar linking cases, I found a hard URL references that should be using :ref: role, and a release notes reference to a (now) broken link (fixing that in the /latest/ version of the 1.10 release notes). Signed-off-by: David B. Kinder <[email protected]>
1 parent 891e50e commit 168751a

File tree

4 files changed

+5
-4
lines changed

4 files changed

+5
-4
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Here's a quick summary of resources to help you find your way around:
7272
* **Zephyr Project Website**: https://zephyrproject.org
7373

7474
.. _Slack Invite: https://tinyurl.com/y5glwylp
75-
.. _supported boards: http://docs.zephyrproject.org/latest/boards
75+
.. _supported boards: http://docs.zephyrproject.org/latest/boards/index.html
7676
.. _Zephyr Documentation: http://docs.zephyrproject.org
7777
.. _Introduction to Zephyr: http://docs.zephyrproject.org/latest/introduction/index.html
7878
.. _Getting Started Guide: http://docs.zephyrproject.org/latest/getting_started/index.html

boards/riscv/qemu_riscv64/doc/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ Get the Toolchain and QEMU
2121
The minimum version of the `Zephyr SDK tools
2222
<https://www.zephyrproject.org/developers/#downloads>`_
2323
with toolchain and QEMU support for the RISV64 architecture is v0.10.2.
24-
Please see the `installation instructions
25-
<https://docs.zephyrproject.org/latest/getting_started/index.html#install-the-required-tools>`_
24+
Please see the :ref:`installation instructions <install-required-tools>`
2625
for more details.
2726

2827
Programming and Debugging

doc/getting_started/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ package is already installed locally but a more recent version is available. It
4444
is good practice to use this flag if the latest version of a package is
4545
required.
4646

47+
.. _install-required-tools:
48+
4749
Install the required tools
4850
===========================
4951

doc/releases/release-notes-1.10.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Build and Infrastructure
138138
either simple one-to-one translations of KBuild features or introduce
139139
new concepts that replace KBuild concepts. Please re-read the Getting
140140
Started guide
141-
(https://docs.zephyrproject.org/getting_started/getting_started.html)
141+
(https://docs.zephyrproject.org/1.10.0/getting_started/getting_started.html)
142142
with updated instructions for setting up and developing on your host-OS.
143143
You *will* need to port your own out-of-tree scripts and Makefiles to
144144
CMake.

0 commit comments

Comments
 (0)