Skip to content

Commit a811d38

Browse files
stephanosiocarlescufi
authored andcommitted
doc: documentation: Update outdated file paths
This commit updates the documentation guidelines to reflect the refactored documentation paths. It also corrects the unnecessary escapes of the backticks. Signed-off-by: Stephanos Ioannidis <[email protected]>
1 parent b6d312a commit a811d38

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doc/contribute/documentation/guidelines.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -262,12 +262,12 @@ markup (double backticks) to indicate a ``filename``.
262262
For references to files that are in the Zephyr GitHub tree, a special
263263
role can be used that creates a hyperlink to that file. For example a
264264
reference to the reST file used to create this document can be generated
265-
using ``:zephyr_file:\`doc/guides/documentation/index.rst\``` that will
266-
show up as :zephyr_file:`doc/guides/documentation/index.rst`, a link to
265+
using ``:zephyr_file:`doc/contribute/documentation/index.rst``` that will
266+
show up as :zephyr_file:`doc/contribute/documentation/index.rst`, a link to
267267
the "blob" file in the github repo. There's also a
268-
``:zephyr_raw:\`doc/guides/documentation/index.rst\``` role that will
268+
``:zephyr_raw:`doc/guides/documentation/index.rst``` role that will
269269
link to the "raw" content,
270-
:zephyr_file:`doc/guides/documentation/index.rst`. (You can click on
270+
:zephyr_raw:`doc/contribute/documentation/index.rst`. (You can click on
271271
these links to see the difference.)
272272

273273
.. _internal-linking:
@@ -603,8 +603,8 @@ sequentially numbered within the document. For example::
603603
Put your right hand in
604604
**********************
605605

606-
See the :zephyr_raw:`doc/getting_started/index.rst` source file and compare
607-
with the :ref:`getting_started` to see a full example. As implemented,
606+
See the :zephyr_raw:`doc/develop/getting_started/index.rst` source file and
607+
compare with the :ref:`getting_started` to see a full example. As implemented,
608608
only one set of numbered steps is intended per document.
609609

610610
For instructions on building the documentation, see :ref:`zephyr_doc`.

0 commit comments

Comments
 (0)