[Documentation] documents rework

.github/workflows/Generator_toc.yml

@@ -2,12 +2,23 @@ name: Generator - TOC
 
 on:
   pull_request:
+    types: [opened, synchronize, reopened, closed]
+    TARGET_PATHS: '**.md'
     paths:
-    - '**.md'
+    - '*.md'
+    - '*/*.md'
+    - '*/*/*.md'
+    - '*/*/*/*.md'
+    - '*/*/*/*/*.md'
+    - '*/*/*/*/*/*.md'
+    - '*/*/*/*/*/*/*.md'
+    - '*/*/*/*/*/*/*/*.md'
+    - '*/*/*/*/*/*/*/*/*.md'
+    - '*/*/*/*/*/*/*/*/*/*.md'
 
 jobs:
   generateTOC:
     name: TOC Generator
     runs-on: ubuntu-latest
     steps:
-      - uses: technote-space/toc-generator@v3
+      - uses: TheGoatGod/toc-generator@v4.0.0

action.yml

@@ -0,0 +1,167 @@
+name: Generator - TOC
+
+description: GitHub Action to generate TOC.
+
+author: technote-space
+
+inputs:
+  GITHUB_TOKEN:
+    description: Secret GitHub API token used to make API requests or git authentication.
+    default: ${{ github.token }}
+    required: true
+  API_TOKEN:
+    description: Secret GitHub API token used to make API requests.
+    required: false
+
+  TARGET_PATHS:
+    description: Target file path. (Comma separated, @see https://github.com/thlorenz/doctoc#adding-toc-to-individual-files)
+    default: 'documents/**.md'
+    required: false
+  TOC_TITLE:
+    description: TOC Title
+    default: '**Table of Contents**'
+    required: false
+  FOLDING:
+    description: Whether to fold.
+    required: false
+  MAX_HEADER_LEVEL:
+    description: Max header level.
+    required: false
+  ENTRY_PREFIX:
+    description: Entry prefix.
+    required: false
+  OPENING_COMMENT:
+    description: Opening comment (for other than DocToc)
+    required: false
+    default: '<!-- toc '
+  CLOSING_COMMENT:
+    description: Closing comment (for other than DocToc)
+    required: false
+    default: '<!-- tocstop '
+  HTML_MODE:
+    description: Whether it is html mode (deprecated).
+    required: false
+  HTML_TEMPLATE:
+    description: Html template for html mode (deprecated)
+    required: false
+    default: <p align="center">${ITEMS}</p>
+  CUSTOM_MODE:
+    description: Whether it is custom mode.
+    required: false
+  CUSTOM_TEMPLATE:
+    description: CUSTOM template for custom mode
+    required: false
+  ITEM_TEMPLATE:
+    description: Item template for custom mode
+    required: false
+    default: <a href="${LINK}">${TEXT}</a>
+  SEPARATOR:
+    description: Separator for custom mode
+    required: false
+    default: <span>|</span>
+  FOOTER:
+    description: Footer
+    required: false
+
+  COMMIT_MESSAGE:
+    description: Commit message.
+    required: true
+    default: 'chore(docs): update TOC'
+  COMMIT_NAME:
+    description: Git commit name.
+    default: ''
+    required: false
+  COMMIT_EMAIL:
+    description: Git commit email.
+    default: ''
+    required: false
+
+  CREATE_PR:
+    description: Whether to create PullRequest.
+    required: false
+  CHECK_ONLY_DEFAULT_BRANCH:
+    description: Whether to check only default branch.
+    required: false
+  PR_BRANCH_PREFIX:
+    description: PullRequest branch prefix.
+    default: 'toc-generator/'
+    required: true
+  PR_BRANCH_NAME:
+    description: PullRequest branch name.
+    default: 'update-toc-${PR_ID}'
+    required: true
+  PR_TITLE:
+    description: PullRequest title.
+    required: true
+    default: 'chore(docs): update TOC (${PR_MERGE_REF})'
+  PR_BODY:
+    description: PullRequest body.
+    required: true
+    default: |
+      ## Base PullRequest
+      ${PR_TITLE} (${PR_NUMBER_REF})
+      ## Command results
+      <details>
+        <summary>Details: </summary>
+        ${COMMANDS_OUTPUT}
+      </details>
+      ## Changed files
+      <details>
+        <summary>${FILES_SUMMARY}: </summary>
+        ${FILES}
+      </details>
+      <hr>
+      [:octocat: Repo](${ACTION_URL}) | [:memo: Issues](${ACTION_URL}/issues) | [:department_store: Marketplace](${ACTION_MARKETPLACE_URL})
+  PR_COMMENT_BODY:
+    description: PullRequest body.
+    required: false
+    default: |
+      ## Command results
+      <details>
+        <summary>Details: </summary>
+        ${COMMANDS_OUTPUT}
+      </details>
+      ## Changed files
+      <details>
+        <summary>${FILES_SUMMARY}: </summary>
+        ${FILES}
+      </details>
+      <hr>
+      [:octocat: Repo](${ACTION_URL}) | [:memo: Issues](${ACTION_URL}/issues) | [:department_store: Marketplace](${ACTION_MARKETPLACE_URL})
+  PR_DEFAULT_BRANCH_PREFIX:
+    description: PullRequest branch prefix for default branch.
+    default: ''
+    required: false
+  PR_DEFAULT_BRANCH_NAME:
+    description: PullRequest branch name for default branch.
+    default: ''
+    required: false
+  PR_DEFAULT_BRANCH_TITLE:
+    description: PullRequest title for default branch.
+    default: ''
+    required: false
+  PR_DEFAULT_BRANCH_BODY:
+    description: PullRequest body for default branch.
+    default: ''
+    required: false
+  PR_CLOSE_MESSAGE:
+    description: Message body when closing PullRequest.
+    default: 'This PR has been closed because it is no longer needed.'
+    required: false
+
+  TARGET_BRANCH_PREFIX:
+    description: Filter by branch name. (e.g. release/)
+    default: ''
+    required: false
+  INCLUDE_LABELS:
+    description: Labels used to check if the PullRequest has it.
+    default: ''
+    required: false
+
+branding:
+  icon: 'book-open'
+  color: 'blue'
+
+runs:
+  using: node12
+  main: lib/main.js

documents/Installation_guide.md → documents/Manual_installation_guide.md

@@ -13,16 +13,15 @@ Use the `home` key to get to the top.
 
 # How to Install - CDDA and the launcher
 
----
 1. CDDA Launcher you can download mods, tile sets and sound sets as well as CDDA's official and experimental releases
+
 * A. [Download the launcher](https://github.com/remyroy/CDDA-Game-Launcher/releases)
 * B. [Forum link](https://discourse.cataclysmdda.org/t/cdda-game-launcher-automatic-updates-and-more/11168)
 
 ---
 
 # How to Install - Stable Ellison-3
 
----
 the  `"mods"`  goes to  `cdda`  or  `cdda\"data"`  folder to go inside the mods folder
 
 1. place `Unlesh_The_Mods\"mods"` folder inside your `cdda\"data"`
@@ -32,7 +31,6 @@ the  `"mods"`  goes to  `cdda`  or  `cdda\"data"`  folder to go inside the mods
 
 # How to Install - Experimental
 
----
 the `"mods"` goes to `cdda` or `cdda\"data"` folder to go  inside the mods folder
 
 1. place `Unlesh_The_Mods\"mods"` folder inside your `cdda\"data"`
@@ -45,7 +43,6 @@ the `"mods"` goes to `cdda` or `cdda\"data"` folder to go  inside the mods folde
 
 # Short FAQ
 
----
 **Q: I'm getting errors!**\
 **A:** `Report the error either on my discord or as an issue on github.`\
 \
@@ -60,3 +57,6 @@ the `"mods"` goes to `cdda` or `cdda\"data"` folder to go  inside the mods folde
 **A:** [Goats Discord Channel](https://discord.gg/gG6qpjZ)
 
 ---
+
+# test
+sjdog

documents/Catalogues/Professions_catalogue.md → documents/Modding/Catalogues/Professions_catalogue.md

@@ -1,10 +1,27 @@
-### Package bionic professions
-```Regex
-"package_bionic_professions"
+# Professions catalogue
+
+Use the `home` key to get to the top.
+
+**Table of Contents**
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Package bionic professions](#package-bionic-professions)
+  - [Professions](#professions-pbp)
+- [More classes scenarios](#more-classes-scenarios)
+  * [Professions](#professions-mcs)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# Package bionic professions
+
+```json
+Mod id
+"id": "package_bionic_professions"
 ```
 
 
-#### Professions
+#### Professions PBP
 ```Json
 `"id": "quiver_bionic_prepper",`
 `"id": "bionic_athlete",`
@@ -34,14 +51,17 @@
 `"id": "razorgirl",`
 ```
 
+---
+
+# More classes scenarios
 
-## More classes scenarios
-```Regex
-"more_classes_scenarios"
+```json
+Mod id
+"id": "more_classes_scenarios"
 ```
 
+#### Professions MCS
 
-#### Professions
 ```Json
 `"id": "specops",`
 `"id": "soldier",`
@@ -55,3 +75,6 @@
 `"id": "goalie",`
 `"id": "elementary_student",`
 ```
+
+---
+