Revise developer instructions

Author: CBroz1

.cspell.json

@@ -25,31 +25,36 @@
         "Battlecharged",
         "codemirror",
         "delim",
-        "excepthook",
+        "Descrip",
         "Erdania",
+        "excepthook",
+        "isort",
         "kernelspec",
         "levelname",
         "manip",
+        "markdownlint",
         "nbconvert",
         "nbformat",
         "premade",
         "Premade",
         "premades",
+        "Prereq",
+        "Prereqs",
         "pydot",
         "reflavoring",
         "remixable",
         "roleplay",
         "Roleplay",
         "ruleset",
+        "Scrying",
         "Shortbow",
         "Shortsword",
-        "Thadius",
         "TTRPG",
         "TTRPGs",
-        "workshopped",
         "Vuln",
         "Vulny",
-        "Vulnys"
+        "Vulnys",
+        "workshopped"
     ],
     // flagWords - list of words to be always considered incorrect
     // This is useful for offensive words and common spelling errors.

.markdownlint.yaml

@@ -9,6 +9,6 @@ MD025: false # permit adjacent headings
 MD026: false # permit trailing punctuation in headings
 MD033: # HTML elements allowed
     allowed_elements:
-        - "br"
+        - "img"
 MD034: false # Bare URLs OK
 MD036: false # permit emphasis as heading

README.md

@@ -17,30 +17,70 @@ about how to play.
 
 ## Developers
 
-### Markdown
+### Getting Started
 
-While not strictly enforced, we ask that you observe
-[Markdown Linting](https://github.com/DavidAnson/markdownlint). The following can be
-added to a vscode settings file. The [Rewrap](https://github.com/stkb/Rewrap/) extension
-supports wrapping to 88 characters.
+1. **Issues**. Proposing changes is as easy as [opening an issue](https://github.com/DeckofAdventures/TheGame/issues/new/choose).
+2. **Edits**. The development team would welcome a PR that made direct edits to existing
+   docs. Be aware that many lists (e.g., Powers, Bestiary, etc.) are managed as `yaml`
+   files that can be edited directly and then transformed before or after a PR.
+3. **Running Code**. The `environment.yaml` file specifies a
+   [Conda](https://docs.conda.io/en/latest/) environment that will allow you to run all
+   code and generate documentation. `mkdocs` will allow you to see what the docs site
+   looks like before commiting by visiting `localhost:8000`
+
+```console
+conda env create -f environment.yaml # Generate conda environment
+conda activate dofa # Activate the environment
+python automation/main.py # Generate md docs
+bash docs/docs.sh serve # Generate md docs and deploy site
+```
+
+### VS Code Extensions
+
+The following VS Code extensions have been used to support development...
+
+1. Markdown Lint: Establishes uniformity across docs
+    - [Extension](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
+    - [GitHub](https://github.com/DavidAnson/markdownlint).
+    - Config: `.markdownlint.yaml`
+2. Rewrap: Supports hard wrapping docs to 88 characters, which makes facilitates PR
+    review. The default keyboard shortcut is `alt+q` or `option+q`.
+    - [Extension](https://marketplace.visualstudio.com/items?itemName=stkb.rewrap)
+    - [GitHub](https://github.com/stkb/Rewrap/)
+3. CSpell: Allows custom dictionaries on spell-check.
+    - [Extension](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)
+    - [GithHub](https://github.com/streetsidesoftware/vscode-spell-checker)
+    - Config: `.cspell.json`
+4. Black Formatter: Supports code uniformity.
+    - [Extension](https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter)
+    - [GitHub](https://github.com/microsoft/vscode-black-formatter)
+
+The following items may also be helpful in a `.vscode/settings.json` file
 
 ```json
 {
     "[markdown]" : {
         "editor.rulers": [88],
         "editor.formatOnPaste": true,
-        "editor.formatOnSave": true,
-        // https://github.com/stkb/Rewrap/
-        // Toggle via command prompt per file
-        // Default paragraph rewrap key: alt+q or option+q
+        "editor.formatOnSave": false,
         "rewrap.autoWrap.enabled": true,
         "rewrap.wrappingColumn": 88
     },
-    // https://github.com/DavidAnson/markdownlint
     "editor.codeActionsOnSave": {
         "source.fixAll.markdownlint":true
     },
-    "markdownlint.focusMode": 5, // ignore issues around the cursor
+    "python.analysis.autoImportCompletions": false,
+    "python.formatting.provider": "black",
+    "python.defaultInterpreterPath": "/YOUR/LOCAL/PATH",
+    "python.formatting.blackArgs": [
+        "--line-length=88",
+        "--exclude='.env'"
+    ],
+    "[python]": {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "ms-python.python"
+    },
+    "notebook.formatOnSave.enabled":true,
 }
 ```
 

docs/src/index.md

@@ -3,7 +3,7 @@ hide:
   - feedback
 ---
 
-# Welcome to Deck of Adventures, The Game!
+# Welcome to Deck of Adventures, The Game
 
 <img src="stylesheets/Logo_Transparent.png" alt="Logo" width="200"/>
 

environment.yaml

@@ -9,3 +9,4 @@ dependencies:
   - pip
   - pip:
     - -r file:requirements.txt
+    - -e .