Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add how to link in contributing/documentation.rst #6001

Merged
merged 1 commit into from
May 17, 2022
Merged

docs: add how to link in contributing/documentation.rst #6001

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions contributing/documentation.rst
View file
Open in desktop
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>`_