From 095fc6feab40a59d04b2123ab3a0fb6146e4bc70 Mon Sep 17 00:00:00 2001 From: Erich Blume Date: Thu, 15 Jan 2026 11:14:26 -0800 Subject: [PATCH] Update zk-docs to pass args to bat and update documentation - zk-docs now passes $@ to bat for custom formatting options - CLAUDE.md: Use zk-docs command instead of direct file reference, with --style=header --color=never --decorations=always for plain output with filenames - README.md: Note that zettelkasten is private, add contact email Co-Authored-By: Claude Opus 4.5 --- CLAUDE.md | 12 +++++++++--- README.md | 9 +++++++-- mise-tasks/zk-docs | 3 ++- 3 files changed, 18 insertions(+), 6 deletions(-) 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 index 58ae06e..dbec30a 100755 --- a/mise-tasks/zk-docs +++ b/mise-tasks/zk-docs @@ -10,4 +10,5 @@ MAIN_CARD="$ZK_DIR/1767747119-YCPO.md" other_cards=$(grep -l '^ - blumeops$' "$ZK_DIR"/*.md 2>/dev/null | grep -v "$(basename "$MAIN_CARD")" | sort) # Concatenate: main card first, then others -bat --style=full "$MAIN_CARD" $other_cards +# Pass through any args to bat (e.g., --style=header --color=never --decorations=always) +bat "$@" "$MAIN_CARD" $other_cards