Skip to content

Commit

Permalink
Update link and add resources
Browse files Browse the repository at this point in the history
  • Loading branch information
keirthana committed Dec 7, 2023
1 parent 29777c3 commit 4902ec8
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion readme.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
Documentation starter pack
==========================

See the `Sphinx and Read the Docs <https://canonical-documentation-with-sphinx-and-readthedocscom.readthedocs-hosted.com/>`_ guide for instructions on how to get started with Sphinx documentation.
See the `Read the Docs at Canonical <https://library.canonical.com/documentation/read-the-docs>`_ and
`How to publish documentation on Read the Docs <https://library.canonical.com/documentation/publish-on-read-the-docs>`_ guides for
instructions on how to get started with Sphinx documentation.

Then go through the following sections to use this starter pack to set up your docs repository.

Expand Down Expand Up @@ -293,6 +295,13 @@ The following links can help you with additional configuration:
- `Sphinx extensions`_
- `Furo documentation`_ (Furo is the Sphinx theme we use as our base.)

Other resources
---------------

- `Example product documentation <https://canonical-example-product-documentation.readthedocs-hosted.com/>`_
- `Example product documentation repository <https://github.com/canonical/example-product-documentation>`_
- `Starter pack repository <https://github.com/canonical/starter-pack>`_

Change log
----------

Expand Down

0 comments on commit 4902ec8

Please sign in to comment.