Skip to content

Commit

Permalink
doc: fix broken doc links
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
dbkinder authored and ioannisg committed Sep 6, 2019
1 parent 891e50e commit 168751a
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Here's a quick summary of resources to help you find your way around:
* **Zephyr Project Website**: https://zephyrproject.org

.. _Slack Invite: https://tinyurl.com/y5glwylp
.. _supported boards: http://docs.zephyrproject.org/latest/boards
.. _supported boards: http://docs.zephyrproject.org/latest/boards/index.html
.. _Zephyr Documentation: http://docs.zephyrproject.org
.. _Introduction to Zephyr: http://docs.zephyrproject.org/latest/introduction/index.html
.. _Getting Started Guide: http://docs.zephyrproject.org/latest/getting_started/index.html
Expand Down
3 changes: 1 addition & 2 deletions boards/riscv/qemu_riscv64/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ Get the Toolchain and QEMU
The minimum version of the `Zephyr SDK tools
<https://www.zephyrproject.org/developers/#downloads>`_
with toolchain and QEMU support for the RISV64 architecture is v0.10.2.
Please see the `installation instructions
<https://docs.zephyrproject.org/latest/getting_started/index.html#install-the-required-tools>`_
Please see the :ref:`installation instructions <install-required-tools>`
for more details.

Programming and Debugging
Expand Down
2 changes: 2 additions & 0 deletions doc/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ package is already installed locally but a more recent version is available. It
is good practice to use this flag if the latest version of a package is
required.

.. _install-required-tools:

Install the required tools
===========================

Expand Down
2 changes: 1 addition & 1 deletion doc/releases/release-notes-1.10.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Build and Infrastructure
either simple one-to-one translations of KBuild features or introduce
new concepts that replace KBuild concepts. Please re-read the Getting
Started guide
(https://docs.zephyrproject.org/getting_started/getting_started.html)
(https://docs.zephyrproject.org/1.10.0/getting_started/getting_started.html)
with updated instructions for setting up and developing on your host-OS.
You *will* need to port your own out-of-tree scripts and Makefiles to
CMake.
Expand Down

0 comments on commit 168751a

Please sign in to comment.