Docs (#9)

* Docs major refactor

* Stakes chapter. Add plots.

* Finalized 1st chapter

* Images directory

* Finalizing 3rd chapter. MD formatting.

* Timeseries refactoring

* Nit

* Refactoring snapshot WIP

* Refactoring snapshot

* Finalize 2nd chapter.

* Nits

* CI nits

* Patch

.github/workflows/publish.yaml

@@ -4,6 +4,8 @@ on:
   schedule:
     - cron: "0 0 * * *"
 
+  workflow_dispatch:
+
 permissions:
   contents: read
 

.github/workflows/test.yaml

@@ -38,15 +38,16 @@ jobs:
       - name: Install Python dependencies
         run: poetry install
 
+      - name: Install AlgoKit
+        run: pipx install algokit
+
       - name: Run LocalNet
-        run: |
-          pipx install algokit
-          algokit localnet start
+        run: algokit localnet start
 
       - name: Sleep to allow the LocalNet to start
         run: |
-          sleep 5
-          algokit localnet status
+          sleep 10
+#          algokit localnet status
 
       - name: Test
         run: poetry run pytest --verbose

.gitignore

@@ -2,4 +2,5 @@
 .idea/
 
 # Artifacts
-.src/artifacts/
+/book
+*.csv

.markdownlint.json

@@ -0,0 +1,7 @@
+{
+    "default": true,
+    "MD013": {
+        "code_blocks": false,
+        "tables": false
+    }
+}

.pre-commit-config.yaml

@@ -38,6 +38,13 @@ repos:
       additional_dependencies: ["types-requests", "types-python-dateutil"]
       language_version: python3.11
 
+# Markdown
+- repo: https://github.com/igorshubovych/markdownlint-cli
+  rev: v0.36.0
+  hooks:
+    - id: markdownlint
+      args: ["--fix"]
+
 # GitHub Actions
 - repo: https://github.com/bridgecrewio/checkov.git
   rev: 2.4.14