Merge pull request #28 from rl-institut/feature-4-restructure-docs

Restructure documentation folders
rl-institut · Feb 20, 2023 · a087dfb · a087dfb
2 parents 380d268 + 16a91b0
commit a087dfb
Show file tree

Hide file tree

Showing 17 changed files with 32 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -33,9 +33,11 @@ Template:
 - Add `requirements.txt` for python environment dependencies [(#20)](https://github.com/rl-institut/super-repo/pull/20)
 - Add templates for issues and PR [(#15)](https://github.com/rl-institut/super-repo/pull/15)
 - Add a GitHub workflow to deploy documentation [(#25)](https://github.com/rl-institut/super-repo/pull/25)
+- Add permanent links for documentation sections [(#28)](https://github.com/rl-institut/super-repo/pull/28)
 
 ### Changed
 - Update the .gitignore [(#19)](https://github.com/rl-institut/super-repo/pull/19)
+- Update the documentation file structure [(#28)](https://github.com/rl-institut/super-repo/pull/28)
 
 ### Removed
 - Remove the `src` folder [(#26)](https://github.com/rl-institut/super-repo/pull/26)

diff --git a/README.rst b/README.rst
@@ -55,7 +55,7 @@ License and Citation
     :alt: License
 
 .. |badge_documentation| image:: https://img.shields.io/github/actions/workflow/status/rl-institut/super-repo/gh-pages.yml?branch=production
-    :target: \docs
+    :target: https://rl-institut.github.io/super-repo/
     :alt: Documentation
 
 .. |badge_contributing| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat

diff --git a/docs/install/index.md → docs/code/install/index.md b/docs/install/index.md → docs/code/install/index.md
diff --git a/docs/style/index.md → docs/code/style/index.md b/docs/style/index.md → docs/code/style/index.md
diff --git a/docs/collaboration/citation.md → docs/development/collaboration/citation.md b/docs/collaboration/citation.md → docs/development/collaboration/citation.md
diff --git a/docs/collaboration/code_of_conduct.md → ...elopment/collaboration/code_of_conduct.md b/docs/collaboration/code_of_conduct.md → ...elopment/collaboration/code_of_conduct.md
diff --git a/docs/collaboration/contributing.md → ...development/collaboration/contributing.md b/docs/collaboration/contributing.md → ...development/collaboration/contributing.md
diff --git a/docs/collaboration/index.md → docs/development/collaboration/index.md b/docs/collaboration/index.md → docs/development/collaboration/index.md
diff --git a/docs/collaboration/license.md → docs/development/collaboration/license.md b/docs/collaboration/license.md → docs/development/collaboration/license.md
diff --git a/docs/collaboration/users.md → docs/development/collaboration/users.md b/docs/collaboration/users.md → docs/development/collaboration/users.md
diff --git a/docs/documentation/index.md → docs/development/documentation/index.md b/docs/documentation/index.md → docs/development/documentation/index.md
diff --git a/docs/git/gitignore.md → docs/development/git/gitignore.md b/docs/git/gitignore.md → docs/development/git/gitignore.md
diff --git a/docs/git/index.md → docs/development/git/index.md b/docs/git/index.md → docs/development/git/index.md
diff --git a/.../git/test-driven-developement-workflow.md → .../git/test-driven-developement-workflow.md b/.../git/test-driven-developement-workflow.md → .../git/test-driven-developement-workflow.md
diff --git a/docs/release/index.md → docs/development/release/index.md b/docs/release/index.md → docs/development/release/index.md
diff --git a/docs/index.md b/docs/index.md
@@ -10,13 +10,26 @@ A template repo to test and document elements and features for research software
 It implements the collection of repository elements and files. <br>
 The goal is to simplify and standardise the creation of software in GitHub repositories.
 
-## Fields for development:
+## Documentation Structure
+
+The documentation is separated into two main sections: 
+`development` and `code documentation`. <br>
+
+### Fields for development
+
+Files and structures related to collaborative development, community processes,
+ and documentation. 
 
 - COLLABORATION
 - GIT
 - DOCUMENTATION
+- RELEASE
+
+### Fields for code documentation
+
+Methods and standards of the module.
+
 - INSTALL
 - CODE-STYLE
 - TESTS
 - LOGGING
-- RELEASE
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -38,6 +38,8 @@ theme:
 # extensions 
 markdown_extensions:
   - admonition
+  - toc:
+      permalink: 💙
 
 plugins:
 - mkdocstrings:
@@ -54,24 +56,24 @@ nav:
   - Home: index.md
   - Development:
     - Collaboration:
-      - collaboration/index.md
-      - License: collaboration/license.md
-      - Citation: collaboration/citation.md
-      - Contributing: collaboration/contributing.md
-      - Users: collaboration/users.md
-      - Code of Conduct: collaboration/code_of_conduct.md
+      - development/collaboration/index.md
+      - License: development/collaboration/license.md
+      - Citation: development/collaboration/citation.md
+      - Contributing: development/collaboration/contributing.md
+      - Users: development/collaboration/users.md
+      - Code of Conduct: development/collaboration/code_of_conduct.md
     - Git:
-      - git/index.md
-      - Gitignore: git/gitignore.md
+      - development/git/index.md
+      - Gitignore: development/git/gitignore.md
     - Documentation:
-      - documentation/index.md
+      - development/documentation/index.md
     - Release:
-      - release/index.md
+      - development/release/index.md
   - Code Documentation:
     - Install:
-      - install/index.md
+      - code/install/index.md
     - Code Style:
-        - style/index.md
+      - code/style/index.md
     - Functions:
       - code/index.md
       - code/code_example.md