Add docs/ with blumeops zk cards #82

Merged
eblume merged 2 commits from feature/docs-from-zk into main 2026-02-02 21:40:53 -08:00
2 changed files with 4 additions and 3 deletions
Showing only changes of commit c9c1e11371 - Show all commits

Update docs references in README.md and CLAUDE.md

- CLAUDE.md: Update rule 2 and 4 to reference docs/ instead of external zk
- CLAUDE.md: Add docs/ to project structure
- README.md: Add mention of obsidian.nvim for editing

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Erich Blume 2026-02-02 21:38:42 -08:00

View file

@ -12,7 +12,7 @@ blumeops is Erich Blume's GitOps repository for personal infrastructure manageme
1. **CRITICAL: Always use `--context=minikube-indri` with kubectl commands.** The user has work contexts configured that must never be touched. Every kubectl command must explicitly specify the context to prevent accidental operations against the wrong cluster. 1. **CRITICAL: Always use `--context=minikube-indri` with kubectl commands.** The user has work contexts configured that must never be touched. Every kubectl command must explicitly specify the context to prevent accidental operations against the wrong cluster.
2. At the start of every session, even if the user asked to do something else, run `mise run zk-docs -- --style=header --color=never --decorations=always` in order to review the `blumeops` documentation in the zettelkasten (zk). zk lives at `~/code/personal/zk`, and is managed via obsidian-sync (not git). 2. At the start of every session, even if the user asked to do something else, run `mise run zk-docs -- --style=header --color=never --decorations=always` in order to review the `blumeops` documentation. The docs live in `docs/` and are git-managed in this repo. (The user's main zk at `~/code/personal/zk` is separate and synced via obsidian-sync.)
3. When making any changes, start by making sure you're on the `main` git branch and up-to-date, and then create a feature branch. Commit often while working, and create a PR using: 3. When making any changes, start by making sure you're on the `main` git branch and up-to-date, and then create a feature branch. Commit often while working, and create a PR using:
```fish ```fish
@ -35,7 +35,7 @@ mise run pr-comments <pr_number>
``` ```
Address each unresolved comment before proceeding. The user will resolve comments on the Forge UI as they are addressed. Address each unresolved comment before proceeding. The user will resolve comments on the Forge UI as they are addressed.
4. Always keep the zk cards up to date with any changes, and suggest new links to new cards whenever appropriate. Refer back to the zk docs often during the process of planning and making corrections to ensure accuracy, and if you make a mistake, figure out a way to guard against it using the zk. 4. Always keep the docs (`docs/`) up to date with any changes, and suggest new links to new cards whenever appropriate. Refer back to the docs often during the process of planning and making corrections to ensure accuracy, and if you make a mistake, figure out a way to guard against it using the docs. The docs use Obsidian wiki-link syntax (`[[link]]`).
5. Use `Brewfile` and `mise.toml` to install tools needed on the development workstation (typically hostnamed "gilbert", username "eblume"). 5. Use `Brewfile` and `mise.toml` to install tools needed on the development workstation (typically hostnamed "gilbert", username "eblume").
@ -52,6 +52,7 @@ Address each unresolved comment before proceeding. The user will resolve comment
## Project Structure ## Project Structure
``` ```
./docs/ # blumeops documentation (Obsidian wiki-link format)
./mise-tasks/ # management and utility scripts run via `mise run` ./mise-tasks/ # management and utility scripts run via `mise run`
./ansible/playbooks/ # ansible playbooks (indri.yml is primary) ./ansible/playbooks/ # ansible playbooks (indri.yml is primary)
./ansible/roles/ # ansible roles for indri-hosted services ./ansible/roles/ # ansible roles for indri-hosted services

View file

@ -86,4 +86,4 @@ Documentation lives in `docs/` and covers infrastructure, services, and operatio
mise run zk-docs mise run zk-docs
``` ```
The docs use [Obsidian](https://obsidian.md) wiki-link syntax (`[[link]]`) for cross-references. The docs use [Obsidian](https://obsidian.md) wiki-link syntax (`[[link]]`) for cross-references. Edit with any markdown editor, or use [obsidian.nvim](https://github.com/obsidian-nvim/obsidian.nvim) for enhanced navigation and completion.