Merge pull request #915 from kaelyndunnell/various-fixes

Update begginer's guide
festim-dev · Nov 4, 2024 · a9d8980 · a9d8980
2 parents 6ec0543 + ebc3168
commit a9d8980
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/docs/source/devguide/index.rst b/docs/source/devguide/index.rst
@@ -1,3 +1,5 @@
+.. _developers_guide:
+
 =================
 Developer's Guide
 =================

diff --git a/docs/source/userguide/beginners_guide.rst b/docs/source/userguide/beginners_guide.rst
@@ -10,7 +10,8 @@ Basic knowledge of `Python <https://www.learnpython.org/>`_ is required to make
 
 New users should familiarise themselves with `Conda <https://anaconda.org/>`_.
 
-FESTIM is under version control with `git <https://git-scm.com/>`_. Even though users don't need git to install FESTIM, it is convenient to understand how it works. You can find `git tutorials <https://git-scm.com/doc>`_ to help you getting started. The `FESTIM source code <https://github.com/festim-dev/FESTIM>`_ is hosted on GitHub. Signing up for free to GitHub is recommended to receive the latest updates, follow the development and submit `bug reports <https://github.com/festim-dev/FESTIM/issues/new/choose>`_.
+FESTIM is under version control with `git <https://git-scm.com/>`_. Even though users don't need git to install FESTIM, it is convenient to have a basic understanding of how it works. You can find `git tutorials <https://git-scm.com/doc>`_ to help you getting started. The `FESTIM source code <https://github.com/festim-dev/FESTIM>`_ is hosted on GitHub.
+Git knowledge and a GitHub account is required to open issues and :ref:`contribute to the code <developers_guide>`.
 
 ----------------------
 Where can I find help?