From 86c969f14b335a02bef5ea0c41a965a7904804d7 Mon Sep 17 00:00:00 2001
From: Shane Holloman <shaneholloman@gmail.com>
Date: Sun, 8 Dec 2024 17:13:48 +1300
Subject: [PATCH] docs: update TODO list and enhance README badges

---
 .github/workflows/todos.yml | 33 +++++++++++++++++++++++++++++++++
 .gitignore                  |  3 +++
 README.md                   |  4 +++-
 docs/todo.md                |  2 ++
 4 files changed, 41 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/todos.yml

diff --git a/.github/workflows/todos.yml b/.github/workflows/todos.yml
new file mode 100644
index 0000000..58fce83
--- /dev/null
+++ b/.github/workflows/todos.yml
@@ -0,0 +1,33 @@
+name: TODOs
+
+on:
+  push:
+    paths:
+      - 'docs/todo.md'
+  workflow_dispatch:
+
+jobs:
+  update-badges:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install PowerShell
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y powershell
+
+      - name: Update TODO badges
+        shell: pwsh
+        run: ./scripts/update-todo-badges.ps1
+
+      - name: Commit changes
+        run: |
+          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add README.md
+          git diff --quiet && git diff --staged --quiet || git commit -m "docs: update todo badges"
+          git push
diff --git a/.gitignore b/.gitignore
index f50804d..ba9398a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,6 +5,9 @@ _codemaps/
 private/
 scripts/
 
+##  History
+.history/
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
diff --git a/README.md b/README.md
index e5b1b67..c40af03 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,9 @@
 
 [![Pylint](https://github.com/shaneholloman/codemapper/actions/workflows/pylint.yml/badge.svg)](https://github.com/shaneholloman/codemapper/actions/workflows/pylint.yml)
 [![PyTest](https://github.com/shaneholloman/codemapper/actions/workflows/pytest.yml/badge.svg)](https://github.com/shaneholloman/codemapper/actions/workflows/pytest.yml)
-[![TODO](https://img.shields.io/badge/✔%20RoadMap-45-blue)](docs/todo.md)
+[![TODO](https://img.shields.io/badge/✔%20Todo-47-purple)](docs/todo.md)
+[![TODO](https://img.shields.io/badge/✔%20Done-8-purple)](docs/todo.md)
+
 ![logo](codemapper-outlined.webp)
 
 <!-- TOC -->
diff --git a/docs/todo.md b/docs/todo.md
index 923644a..43d37fc 100644
--- a/docs/todo.md
+++ b/docs/todo.md
@@ -26,6 +26,8 @@ tag is: [`core`](https://github.com/users/shaneholloman/projects/9/views/7)
 
 tag is: [`outputs`](https://github.com/users/shaneholloman/projects/9/views/7)
 
+- [ ] Default output dirs will be .docmaps and .codemaps
+- [ ] Consider adding an additional `llms.txt` to satisfy the new hype-train of making a `robots.txt` equivalent
 - [x] Generate `*_codemap.md` for file contents and directory structure
 - [x] Create separate `*_docmap.md` for documentation directories
 - [x] Add repository source information to output file header