resolved conversation

Author: Jannis-Mittenzwei

doc/user_guide/features.rst

@@ -1,10 +1,13 @@
 Features
 ========
 
-Uniformed Project Layout
-------------------------
+Uniform Project Layout
+----------------------
 
-Overall, the toolbox generally expects a certain project layout because it tries to follow the credo "convention over configuration" when possible and reasonable. This expected structure can be better understood by looking at the cookie-cutter project template, which is part of the python-toolbox workspace and can be found in `project-template`. One can also generate a project from the template to explore the default structure. For more details on this, please check out the getting started section.
+PTB expects a default project layout following "convention over configuration" when possible and reasonable.
+See the cookie-cutter project template for details, which is part of the python-toolbox workspace and can be found in directory `project-template`.
+You can also generate a project from the template to explore the default structure.
+For more details on this, please check out section `"getting started" <getting_started.html>`_ section.
 
 Nox
 ---
@@ -20,9 +23,9 @@ Central files in regards to nox and the toolbox are:
 Important Nox Commands
 ^^^^^^^^^^^^^^^^^^^^^^
 
-* :code:`nox -l` this command shows a list of all available nox tasks
-* :code:`nox -s <tasks>` to run the specified task(s)
-    * :code:`nox -s test:typing` which runs the type checker on the project
+* :code:`nox -l` shows a list of all available nox tasks
+* :code:`nox -s <tasks>` run the specified task(s)
+    * :code:`nox -s test:typing` runs the type checker on the project
     * :code:`nox -s docs:clean docs:build docs:open`
         #. first task removes the documentation folder
         #. second one builds the documentation

doc/user_guide/how_to_release.rst

@@ -1,11 +1,12 @@
 How to Release
 ==============
 
-#.  Use the command :code:`nox -s release:prepare` to prepare the project for a new release.
-#.  Merge your **Pull Request** to main
-#.  Switch the **current branch** to the **default branch**
-#.  Ensure default branch to be up to date: :code:`git pull`
-#.  Set your **tag name**: :code:`TAG=<name>`
+#.  Use :code:`nox -s release:prepare` to prepare the project for a new release.
+#.  Merge your **Pull Request** to the **default branch**
+#.  Use :code:`git remote show origin | sed -n '/HEAD branch/s/.*: //p'` to output the **default branch**
+#.  Use :code:`git checkout <default branch>` Switch to the **default branch**
+#.  Use :code:`git pull` to update branch
+#.  Use :code:`TAG=<name>` to set a variable named **"TAG"**
 #.  Use :code:`git tag "${TAG}"` to create a new tag in your repo
-#.  Use :code:`git push origin "${TAG}"` to push it in your remote repo
-#.  GitHub workflow reacts on this tag and starts the release process
+#.  Use :code:`git push origin "${TAG}"` to push it to remote
+#.  GitHub workflow **CD** reacts on this tag and starts the release process