Merge pull request #97 from rl-institut/feature-92-bugs

Improve documentation after latest release #92

Author: Ludee

.github/pull_request_template.md

@@ -20,7 +20,7 @@ Describe the findings of the discussion in the issue or meeting.
 
 ### Automation
 
-Part of # / Closes #
+Closes # / Part of #
 
 ### PR-Assignee
 
@@ -31,5 +31,5 @@ Part of # / Closes #
 
 ### Reviewer
 
-- [ ] 🐙 Follow the [Reviewer Guidelines](https://github.com/rl-institut/super-repo/blob/production/CONTRIBUTING.md#40-let-someone-else-review-your-pr)
+- [ ] 🐙 Follow the [Reviewer Guidelines](https://github.com/rl-institut/super-repo/blob/production/CONTRIBUTING.md#40--let-someone-else-review-your-pr)
 - [ ] 🐙 Provided feedback and show sufficient appreciation for the work done

.github/workflows/reuse.yml

@@ -2,7 +2,7 @@
 # SPDX-FileCopyrightText: super-repo v0.5.0 <https://github.com/rl-institut/super-repo>
 # SPDX-License-Identifier: MIT
 
-name: 📝REUSE Compliance Check
+name: 📝 REUSE Compliance Check
 
 on: [push, pull_request]
 

CHANGELOG.md

@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 ### Changed
+- Update README and documentation [(#97)](https://github.com/rl-institut/super-repo/pull/97)
 
 ### Removed
 

CODE_OF_CONDUCT.md

@@ -22,23 +22,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-- Demonstrating empathy and kindness toward other people
-- Being respectful of differing opinions, viewpoints, and experiences
-- Giving and gracefully accepting constructive feedback
-- Accepting responsibility and apologizing to those affected by our mistakes,
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-- Focusing on what is best not just for us as individuals, but for the overall
+* Focusing on what is best not just for us as individuals, but for the overall
   community
 
 Examples of unacceptable behavior include:
 
-- The use of sexualized language or imagery, and sexual attention or advances of
+* The use of sexualized language or imagery, and sexual attention or advances of
   any kind
-- Trolling, insulting or derogatory comments, and personal or political attacks
-- Public or private harassment
-- Publishing others' private information, such as a physical or email address,
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
   without their explicit permission
-- Other conduct which could reasonably be considered inappropriate in a
+* Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -58,7 +58,7 @@ decisions when appropriate.
 This Code of Conduct applies within all community spaces, and also applies when
 an individual is officially representing the community in public spaces.
 Examples of representing our community include using an official e-mail address,
-posting by way of an official social media account, or acting as an appointed
+posting via an official social media account, or acting as an appointed
 representative at an online or offline event.
 
 ## Enforcement

README.rst

@@ -28,7 +28,7 @@ super-repo
    * - Development
      - |badge_issue_open| |badge_issue_closes| |badge_pr_open| |badge_pr_closes|
    * - Community
-     - |badge_contributions| |badge_contributors| |badge_repo_counts| |badge_matrix|
+     - |badge_contributions| |badge_contributors| |badge_matrix| |badge_repo_counts|
 
 .. contents::
     :depth: 2
@@ -80,7 +80,7 @@ License and Citation
     :target: https://rl-institut.github.io/super-repo/
     :alt: Documentation
 
-.. |badge_mkdocs| image:: https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white
+.. |badge_mkdocs| image:: https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=flat&logo=MaterialForMkDocs&logoColor=white&color=grey
     :target: https://squidfunk.github.io/mkdocs-material/
     :alt: MkDocs
 
@@ -106,32 +106,32 @@ License and Citation
 
 .. |badge_issue_open| image:: https://img.shields.io/github/issues-raw/rl-institut/super-repo
     :target: https://github.com/rl-institut/super-repo/issues
-    :alt: open issues
+    :alt: Open Issues
 
 .. |badge_issue_closes| image:: https://img.shields.io/github/issues-closed-raw/rl-institut/super-repo
     :target: https://github.com/rl-institut/super-repo/issues?q=is%3Aissue+is%3Aclosed
-    :alt: closes issues
+    :alt: Closed Issues
 
 .. |badge_pr_open| image:: https://img.shields.io/github/issues-pr-raw/rl-institut/super-repo
     :target: https://github.com/rl-institut/super-repo/pulls
-    :alt: closes issues
+    :alt: Open PR
 
 .. |badge_pr_closes| image:: https://img.shields.io/github/issues-pr-closed-raw/rl-institut/super-repo
     :target: https://github.com/rl-institut/super-repo/pulls?q=is%3Apr+is%3Aclosed
-    :alt: closes issues
+    :alt: Closed PR
 
 .. |badge_contributions| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
     :target: https://github.com/rl-institut/super-repo/blob/production/CONTRIBUTING.md
-    :alt: contributions
+    :alt: Contributions
 
 .. |badge_contributors| image:: https://img.shields.io/github/contributors/rl-institut/super-repo
     :target: https://github.com/rl-institut/super-repo/graphs/contributors
-    :alt: contributors
-
-.. |badge_repo_counts| image:: https://hits.sh/github.com/rl-institut/super-repo.svg
-    :target: https://hits.sh/github.com/rl-institut/super-repo/
-    :alt: hits
+    :alt: Contributors
 
 .. |badge_matrix| image:: https://img.shields.io/matrix/super-repo:matrix.org
     :target: https://app.element.io/#/room/#super-repo:matrix.org
     :alt: Matrix
+
+.. |badge_repo_counts| image:: https://hits.sh/github.com/rl-institut/super-repo.svg
+    :target: https://hits.sh/github.com/rl-institut/super-repo/
+    :alt: Hits

docs/development/collaboration/license_and_citation.md

@@ -31,7 +31,7 @@ All copyright information should follow this example:
 ```
 SPDX-FileCopyrightText: {$year_of_file_creation} {$name_of_author} <{contact}> © {$name_of_copyright_holder}
 SPDX-FileCopyrightText: {$year_of_file_creation} {$name_of_author2} <{contact2}> © {$name_of_copyright_holder2}
-
+SPDX-FileCopyrightText: {$repo-name} {$version} <{$link}>
 SPDX-License-Identifier: {$SPDX_license_name}
 ```
 

docs/development/release/index.md

@@ -8,7 +8,7 @@ The software release has four main goals:
 4. Publish a new version of the package at PyPI
 
 The 📝 [RELEASE_PROCEDURE.md](https://github.com/rl-institut/super-repo/blob/production/RELEASE_PROCEDURE.md)
-contain detailed instructions to do a release.
+contains detailed instructions to do a release.
 
 ## Automated Versioning with Bumpversion
 

docs/user_documentation/install/index.md

@@ -5,8 +5,7 @@
 With conda, you can create, export, list, remove, and update environments
 that have different versions of Python and/or packages installed in them. <br>
 Switching or moving between environments is called activating the environment.
-You can also share an environment file and import from 📝 `requirements.txt`.
-
+You can also share an environment file and import from 📝 `requirements.txt`. <br>
     💻 `conda env create -f environment.yaml` Create conda environment <br>
     💻 `conda activate py310` Activate environment <br>
     💻 `python --version` Check python version