Expand usage of doctoc for md file table of content generation

Author: kevingranade

.github/workflows/toc.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - run: npx doctoc doc/JSON/JSON_INFO.md --github
+      - run: npx doctoc --github --title "*Contents*" --update-only doc/
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v6
         with:

doc/ASCII_ART.md

@@ -1,3 +1,15 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+*Contents*
+
+- [Making ASCII art for CDDA](#making-ascii-art-for-cdda)
+  - [ASCII art Editors](#ascii-art-editors)
+  - [Installing REXPaint](#installing-rexpaint)
+  - [Drawing](#drawing)
+  - [Exporting](#exporting)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 ## Making ASCII art for CDDA
 ### ASCII art Editors
 ASCII art can be made using any text editor, such as Notepad, but it's more convenient to use an editor created for making ASCII art. There are many ASCII art editors on the internet, but this guide focuses on REXPaint because aside from many useful features like drawing ellipses, rectangles, lines and other shapes, it's the only editor with the option to export images to a format readable by CDDA. Note that this is not a comprehensive REXPaint manual, you can find the full manual [here](https://github.com/Lucide/REXPaint-manual/blob/master/manual.md) or in your REXPaint folder.

doc/CONTRIBUTING.md

@@ -1,3 +1,36 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+*Contents*
+
+- [Contribute](#contribute)
+  - [Licensing and Authorship](#licensing-and-authorship)
+  - [Using a good text editor](#using-a-good-text-editor)
+  - [All PRs must have a "Summary" section](#all-prs-must-have-a-summary-section)
+  - [Contributing via GitHub](#contributing-via-github)
+  - [Code Style](#code-style)
+  - [Translations](#translations)
+  - [Doxygen Comments](#doxygen-comments)
+    - [Guidelines for adding documentation](#guidelines-for-adding-documentation)
+    - [Building the documentation for viewing it locally](#building-the-documentation-for-viewing-it-locally)
+  - [Example Workflow](#example-workflow)
+      - [Setup your environment](#setup-your-environment)
+      - [Update your `master` branch](#update-your-master-branch)
+      - [Make your changes](#make-your-changes)
+  - [Drafts](#drafts)
+    - [Comment requests](#comment-requests)
+    - [Keep your PR description relevant](#keep-your-pr-description-relevant)
+    - [Closing issues using keywords](#closing-issues-using-keywords)
+  - [Tooling support](#tooling-support)
+  - [Advanced Techniques](#advanced-techniques)
+      - [Using remote tracking branches](#using-remote-tracking-branches)
+  - [Unit tests](#unit-tests)
+  - [In-game testing, test environment and the debug menu](#in-game-testing-test-environment-and-the-debug-menu)
+  - [Frequently Asked Questions](#frequently-asked-questions)
+      - [Why does `git pull --ff-only` result in an error?](#why-does-git-pull---ff-only-result-in-an-error)
+      - [Oh no! I've made my changes to `master` branch and have pushed it to my repo! What should I do now?](#oh-no-ive-made-my-changes-to-master-branch-and-have-pushed-it-to-my-repo-what-should-i-do-now)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Contribute
 
 **Opening a new issue?** Please read [ISSUES.md](../ISSUES.md) first.

doc/DEVELOPER_FAQ.md

@@ -1,3 +1,19 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+*Contents*
+
+- [Developer FAQ](#developer-faq)
+  - [Adding stuff](#adding-stuff)
+  - [Adding a monster](#adding-a-monster)
+  - [Adding structures to the map](#adding-structures-to-the-map)
+  - [Adding a bionic](#adding-a-bionic)
+  - [How armor protection is calculated](#how-armor-protection-is-calculated)
+  - [Adding an iuse function.](#adding-an-iuse-function)
+  - [Acid resistance](#acid-resistance)
+- [FAQ](#faq)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Developer FAQ
 
 ## Adding stuff

doc/GUN_NAMING_AND_INCLUSION.md

@@ -1,3 +1,21 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+*Contents*
+
+- [Gun Naming and Inclusion Guidelines](#gun-naming-and-inclusion-guidelines)
+  - [Generic Guns](#generic-guns)
+  - [Gun Brand Names (`gun` type variants)](#gun-brand-names-gun-type-variants)
+- [Inclusion Criteria](#inclusion-criteria)
+  - [Rarity Threshold](#rarity-threshold)
+    - [Civilian Firearms](#civilian-firearms)
+    - [Military and Police Firearms](#military-and-police-firearms)
+  - [Difference Threshold](#difference-threshold)
+- [Gun Naming](#gun-naming)
+  - [Rule 1 (Descriptive Names): What is this?](#rule-1-descriptive-names-what-is-this)
+  - [Rule 2 (Identifier Check): What goes with this?](#rule-2-identifier-check-what-goes-with-this)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Gun Naming and Inclusion Guidelines
 
 Cataclysm: Dark Days Ahead includes much of the complexity embodied by guns in

doc/HOW_YOU_CAN_HELP.md

@@ -1,3 +1,17 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+*Contents*
+
+- [How You Can Help](#how-you-can-help)
+  - [Other ways to help](#other-ways-to-help)
+  - [Issue labels](#issue-labels)
+    - [Languages](#languages)
+    - [Issue Types](#issue-types)
+    - [Gameplay Categories](#gameplay-categories)
+    - [Flags](#flags)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # How You Can Help
 
 CDDA is maintained by thousands of volunteers, organized by a core development team. There are many

doc/IN_REPO_MODS.md

@@ -1,3 +1,18 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+*Contents*
+
+- [Getting Mods Into The Repository](#getting-mods-into-the-repository)
+  - [Why have in-repo mods?](#why-have-in-repo-mods)
+  - [What kind of mods can be in the CleverRaven repository?](#what-kind-of-mods-can-be-in-the-cleverraven-repository)
+  - [What is necessary for a mod to be included in the repository?](#what-is-necessary-for-a-mod-to-be-included-in-the-repository)
+  - [What are the responsibilities of a mod curator?](#what-are-the-responsibilities-of-a-mod-curator)
+  - [When do mods get removed?](#when-do-mods-get-removed)
+  - [Why do mods get removed?](#why-do-mods-get-removed)
+  - [How can mods be rescued from removal?](#how-can-mods-be-rescued-from-removal)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Getting Mods Into The Repository
 
 Cataclysm: Dark Days Ahead is not only moddable, but ships with a number of mods available for users to select from even without having to obtain mods from a third party source.

doc/ISSUE_TRIAGE.md

@@ -1,3 +1,17 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+*Contents*
+
+- [Why triage?](#why-triage)
+- [How does triage work?](#how-does-triage-work)
+  - [Is this a bug report or a feature request?](#is-this-a-bug-report-or-a-feature-request)
+  - [Bug priority](#bug-priority)
+  - [Bug validity](#bug-validity)
+  - [Feature request validity](#feature-request-validity)
+    - [Outcomes for invalid feature requests](#outcomes-for-invalid-feature-requests)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 ## Why triage?
 
 Triage is a process of sanity checking and prioritizing issues. The term is adopted from medical contexts where patients are briefly examined to decide whether they need immediate care, or if their issue can wait until patients at greater risk can be handled first.

doc/JSON/ARTIFACTS.md

@@ -1,3 +1,22 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+*Contents*
+
+- [Artifacts](#artifacts)
+  - [Introduction](#introduction)
+  - [Generation](#generation)
+    - [charge_types](#charge_types)
+      - [recharge_types](#recharge_types)
+      - [recharge_conditions](#recharge_conditions)
+    - [passive_add_procgen_values and passive_mult_procgen_values](#passive_add_procgen_values-and-passive_mult_procgen_values)
+      - [ench_has](#ench_has)
+    - [type_weights](#type_weights)
+    - [items](#items)
+  - [Power Level](#power-level)
+  - [Resonance](#resonance)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Artifacts
 
 ## Introduction

doc/JSON/BASECAMP.md

@@ -1,3 +1,27 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+*Contents*
+
+- [Basecamp](#basecamp)
+  - [Recommended reading](#recommended-reading)
+  - [Adding alternate basecamp upgrade paths](#adding-alternate-basecamp-upgrade-paths)
+  - [recipe JSONs](#recipe-jsons)
+    - [blueprint requires, provides, and excludes](#blueprint-requires-provides-and-excludes)
+    - [Sample recipe JSON](#sample-recipe-json)
+  - [mapgen update JSON](#mapgen-update-json)
+    - [Sample mapgen update JSON](#sample-mapgen-update-json)
+    - [Parametric mapgen](#parametric-mapgen)
+  - [Recipe groups](#recipe-groups)
+    - [Upgrade Paths and Expansions](#upgrade-paths-and-expansions)
+      - [Examples](#examples)
+  - [Sample basecamp upgrade path](#sample-basecamp-upgrade-path)
+  - [Modular Basecamp conventions](#modular-basecamp-conventions)
+    - [Layout](#layout)
+    - [Naming scheme](#naming-scheme)
+- [Adding basecamp expansions](#adding-basecamp-expansions)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Basecamp
 
 ## Recommended reading