Added and applied npm run docformat

docs/DEV.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**
+
+* [Developing this add-on](#developing-this-add-on)
+  * [Preparations](#preparations)
+  * [Getting started](#getting-started)
+  * [Details](#details)
+  * [Loading the Web Extension in Firefox](#loading-the-web-extension-in-firefox)
+  * [Seeing the add-on in action](#seeing-the-add-on-in-action)
+  * [Automated testing](#automated-testing)
+  * [Directory Structure and Files](#directory-structure-and-files)
+  * [General Shield Study Engineering](#general-shield-study-engineering)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Developing this add-on
 
 ### Preparations

docs/TELEMETRY.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**
+
+* [Telemetry sent by this add-on](#telemetry-sent-by-this-add-on)
+  * [Usual Firefox Telemetry is unaffected.](#usual-firefox-telemetry-is-unaffected)
+  * [Study-specific endings](#study-specific-endings)
+  * [`shield-study` pings (common to all shield-studies)](#shield-study-pings-common-to-all-shield-studies)
+  * [`shield-study-addon` pings, specific to THIS study.](#shield-study-addon-pings-specific-to-this-study)
+  * [Example sequence for a 'voted => not sure' interaction](#example-sequence-for-a-voted--not-sure-interaction)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Telemetry sent by this add-on
 
 ## Usual Firefox Telemetry is unaffected.

docs/TESTPLAN.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**
+
+* [Test plan for this add-on](#test-plan-for-this-add-on)
+  * [Manual / QA TEST Instructions](#manual--qa-test-instructions)
+    * [Preparations](#preparations)
+    * [Install the add-on and enroll in the study](#install-the-add-on-and-enroll-in-the-study)
+  * [Expected User Experience / Functionality](#expected-user-experience--functionality)
+    * [Do these tests](#do-these-tests)
+    * [Design](#design)
+    * [Note: checking "sent Telemetry is correct"](#note-checking-sent-telemetry-is-correct)
+  * [Debug](#debug)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Test plan for this add-on
 
 ## Manual / QA TEST Instructions

docs/WINDOWS_SETUP.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**
+
+* [Windows Development and Testing](#windows-development-and-testing)
+  * [Requirements](#requirements)
+  * [Installing WSL](#installing-wsl)
+  * [Optional](#optional)
+  * [Known Issues](#known-issues)
+  * [TODO](#todo)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Windows Development and Testing
 
 The Shield Studies Add-on Template makes some assumptions about your environment that can be challenging to meet on Windows machines. So far the most promising approach uses the **Windows Subsystem for Linux (WSL)**. WSL is a young project with bugs and unexpected pitfalls; caveat emptor.

package.json

@@ -49,6 +49,7 @@
   "scripts": {
     "build": "web-ext build",
     "bundle-utils": "cp node_modules/shield-studies-addon-utils/dist/StudyUtils.jsm src/privileged/shieldUtils/jsm/StudyUtils.jsm",
+    "docformat": "doctoc --title '**Contents**' docs/*.md && prettier '**/*.md' --write",
     "eslint": "eslint . --ext jsm --ext js --ext json",
     "eslint-fix": "npm run eslint -- --fix",
     "format": "prettier '**/*.{css,js,json,jsm,md}' --trailing-comma=all --ignore-path=.eslintignore --write",