From 070f26dc6d4e56dfde9156b3036b56613a3bbccf Mon Sep 17 00:00:00 2001 From: Erich Blume Date: Thu, 15 Jan 2026 11:25:02 -0800 Subject: [PATCH] Add zk-docs mise task for zettelkasten documentation (#10) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Summary - Add `mise run zk-docs` task to concatenate all blumeops-tagged zettelkasten cards - Main project card is shown first, followed by service management logs - Uses `bat` for output (added to Brewfile) - Args are passed through to bat for custom formatting - Update CLAUDE.md to use zk-docs command with plain output options - Update README.md to note zettelkasten is private with contact email ## Test plan - [x] `mise run zk-docs` displays all 6 blumeops cards - [x] `mise run zk-docs -- --style=header --color=never --decorations=always` shows filenames without decoration 🤖 Generated with [Claude Code](https://claude.com/claude-code) Reviewed-on: https://forge.tail8d86e.ts.net/eblume/blumeops/pulls/10 --- Brewfile | 1 + CLAUDE.md | 12 +++++++++--- README.md | 9 +++++++-- mise-tasks/zk-docs | 14 ++++++++++++++ 4 files changed, 31 insertions(+), 5 deletions(-) create mode 100755 mise-tasks/zk-docs diff --git a/Brewfile b/Brewfile index af2fe6d..68803fb 100644 --- a/Brewfile +++ b/Brewfile @@ -1,2 +1,3 @@ # CLI tools for blumeops management +brew "bat" # Syntax-highlighted file concatenation brew "tea" # Gitea/Forgejo CLI for forge.tail8d86e.ts.net diff --git a/CLAUDE.md b/CLAUDE.md index fd6fc27..9639c5b 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -10,13 +10,19 @@ blumeops is Erich Blume's GitOps repository for personal infrastructure manageme ## Documentation -Project documentation lives in the zettelkasten at `~/code/personal/zk`. Start with the project card: [1767747119-YCPO.md](~/code/personal/zk/1767747119-YCPO.md). +Project documentation lives in the zettelkasten at `~/code/personal/zk`. Read all blumeops documentation with: -You are encouraged to explore the zk, follow links, and propose updates to it as the project evolves. +```bash +mise run zk-docs -- --style=header --color=never --decorations=always +``` + +This displays all cards tagged `blumeops`, with the main project card first and filenames shown for each card. + +You are encouraged to explore the zk, follow links, and propose updates to it as the project evolves. **Always keep the zettelkasten documentation up to date with any changes you make.** ## Rules for all sessions -1. Always start by consulting the project card. +1. Always start by reading the zk docs with the command above. 2. Expand and correct the cards of the zettelkasten. 3. Use `Brewfile` and `mise.toml` to install tools. 4. Use `brew services` or Launch Agents to control services on macos hosts. diff --git a/README.md b/README.md index d3bae1d..a53df17 100644 --- a/README.md +++ b/README.md @@ -51,5 +51,10 @@ to learn. ## Documentation -Detailed documentation lives in my zettelkasten: -- [blumeops project card](~/code/personal/zk/1767747119-YCPO.md) +Detailed documentation lives in my personal zettelkasten, which is not included in this repository. You can view the docs with: + +```bash +mise run zk-docs +``` + +The zettelkasten is private at time of writing. If you're interested in the documentation or have questions about this project, please reach out to blume.erich@gmail.com. diff --git a/mise-tasks/zk-docs b/mise-tasks/zk-docs new file mode 100755 index 0000000..dbec30a --- /dev/null +++ b/mise-tasks/zk-docs @@ -0,0 +1,14 @@ +#!/usr/bin/env bash +#MISE description="Concatenate all blumeops zettelkasten cards" + +set -euo pipefail + +ZK_DIR="$HOME/code/personal/zk" +MAIN_CARD="$ZK_DIR/1767747119-YCPO.md" + +# Find all files tagged with blumeops (excluding main card) +other_cards=$(grep -l '^ - blumeops$' "$ZK_DIR"/*.md 2>/dev/null | grep -v "$(basename "$MAIN_CARD")" | sort) + +# Concatenate: main card first, then others +# Pass through any args to bat (e.g., --style=header --color=never --decorations=always) +bat "$@" "$MAIN_CARD" $other_cards