Skip to content

Commit

Permalink
Merge pull request #6001 from kenjis/update-contributing/documentatio…
Browse files Browse the repository at this point in the history
…n.rst

docs: add how to link in contributing/documentation.rst
  • Loading branch information
kenjis authored May 17, 2022
2 parents c93b967 + 945df7b commit 7c30113
Showing 1 changed file with 19 additions and 9 deletions.
28 changes: 19 additions & 9 deletions contributing/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ on readability and user friendliness.
While they can be quite technical, we always write for humans!

A local table of contents should always be included, like the one below.
It is created automatically by inserting the following:

::
It is created automatically by inserting the following::

.. contents::
:local:
Expand Down Expand Up @@ -86,8 +84,8 @@ create these with the following tab triggers::
References
**********

References to a Section
=======================
To a Section
============

If you need to link to a specific section, the first you add the label before a header::

Expand All @@ -102,11 +100,23 @@ And then you can reference it like this::

See :ref:`curlrequest-request-options-headers` for how to add.

References to a Page
====================
To a Section in the Page
========================

You can reference a section in the current page like the following::

See `Result Rows`_

To a Page
=========

You can reference a page like the following::

:doc:`Session <../libraries/sessions>` library
See :doc:`Session <../libraries/sessions>` library

See :doc:`../libraries/sessions` library

To a URL
========

:doc:`../libraries/sessions` library
`CodeIgniter 4 framework <https://github.com/codeigniter4/framework>`_

0 comments on commit 7c30113

Please sign in to comment.