Update documentation #34

docs/development/best-practice/pre_commit_hooks.md

@@ -1,12 +1,12 @@
 # Pre-commit Hooks
 
-Pre-commit hooks are tools used to enforce code quality and consistency by <br>
+Pre-commit hooks are tools used to enforce code quality and consistency by
 running checks or scripts before changes are committed. <br>
 These hooks help identify issues early, improving code hygiene.
 
 ## Installation and Setup
 
-Install the package in your base environment.
+Install the package in your base environment. <br>
    💻 `pip install pre-commit`
 
 Create a 📝 `.pre-commit-config.yaml` file in your repository root. <br>

docs/development/best-practice/test_driven_development.md

@@ -1,14 +1,14 @@
 # Test-Driven Development
 
 Test-Driven Development (TDD) is a software development methodology that
-emphasizes writing tests before implementing the corresponding functionality. <br>
+emphasizes writing tests before implementing the corresponding functionality.
 This approach ensures that new changes do not unintentionally break existing
 features and that all functions perform as expected.
 
 ## Code Coverage
 
 Code coverage is a metric used in software testing that helps determine
-the percentage of code that is exercised by tests. <br>
+the percentage of code that is exercised by tests.
 It is an essential tool for assessing the effectiveness of your test suite.
 High code coverage generally indicates that most of your code has been tested,
 while lower coverage can suggest that some parts of the application may be
@@ -23,23 +23,23 @@ coverage gaps, and areas that require further testing.
 To integrate Codecov with your project, follow these steps:
 
 1. Install pytest <br>
-    💻 `pip install pytest pytest-cov` install pytest
+    💻 `pip install pytest pytest-cov`
 
 2. Add GitHub Action <br>
    📝 `.github/workflows/codecov.yml`
 
-3. Create an account
+3. Create an account <br>
 Create a Codecov account at [Codecov.io](https://about.codecov.io/) and link your repository.
 
-4. Upload the Coverage Report
+4. Upload the Coverage Report <br>
 After running your tests with coverage, upload the results to Codecov. <br>
 This is  done automatically through the CI configuration.
 
-5. View Coverage Reports
+5. View Coverage Reports <br>
 Once your coverage report is uploaded, you can view detailed insights and trends
 on the Codecov dashboard.
 
-6. Code Coverage Badge
+6. Code Coverage Badge <br>
 A coverage badge provides a visual indication of the test coverage for the
 📝 `README.rst` page. It is updated automatically as new reports are uploaded to Codecov.
 

docs/development/collaboration/users.md

@@ -1,5 +1,11 @@
 # Users
 
 Known user of this software can be added to
-[USERS.cff](https://github.com/rl-institut/super-repo/blob/production/USERS.cff)
-for reference.
+📝 [USERS.cff](https://github.com/rl-institut/super-repository/blob/production/USERS.cff)
+for reference. <br>
+Please use the 📝 `issue_template_user_kudos.md`.
+
+
+
+!!! note "Used Icons"
+    🐙 GitHub | 💠 git | 📝 File | 💻 Command Line

mkdocs.yml

@@ -71,13 +71,14 @@ nav:
     - Collaboration:
       - development/collaboration/index.md
       - License and Citation: development/collaboration/license_and_citation.md
-      - Git: development/git/index.md
+      - Git: development/collaboration/git.md
       - Users: development/collaboration/users.md
       - Chat: development/collaboration/chat.md
       - Meetings: development/collaboration/meeting.md
       - Code of Conduct: development/collaboration/code_of_conduct.md
     - Best Practices:
-      - Continuous Integration: development/best-practice/continuous-integration.md
+      - development/best-practice/index.md
+      - Continuous Integration: development/best-practice/continuous_integration.md
       - Test-Driven Development: development/best-practice/test_driven_development.md
       - Pre-commit Hooks: development/best-practice/pre_commit_hooks.md
       - Code Style: development/best-practice/code_style.md