blumeops/docs/README.md
Erich Blume 7112297150 Move zk cards to docs/zk/ for documentation restructuring
Phase 1 of docs restructuring: move all zettelkasten cards to a
temporary docs/zk/ subdirectory while preparing to build a new
Diataxis-based documentation structure.

- Move all existing markdown files from docs/ to docs/zk/
- Update zk-docs mise task to look in the new location
- Add docs/README.md explaining the restructuring plan

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-03 07:57:47 -08:00

2.1 KiB

Blumeops Documentation

This directory contains documentation for blumeops, Erich Blume's personal infrastructure GitOps repository.

Documentation Restructuring (In Progress)

The documentation is being restructured to follow the Diataxis documentation framework while serving multiple audiences:

Target Audiences

  1. Erich (owner) - A knowledge graph/zettelkasten for quickly recalling important facts about blumeops infrastructure and operations.

  2. Claude/AI agents - Memory and context enrichment for AI-assisted operations and development.

  3. New external readers - People who want to understand "what is blumeops?" at a high level.

  4. Potential operators/contributors - External readers who want to help operate, modify, or answer questions about blumeops, or onboard as a member.

  5. Replicators - People who want to duplicate this approach for their own personal infrastructure operations.

Planned Structure (Diataxis)

The final documentation structure will include:

  • Tutorials - Learning-oriented guides for getting started
  • How-to Guides - Task-oriented instructions for specific operations
  • Reference - Information-oriented technical descriptions
  • Explanation - Understanding-oriented discussion of concepts and decisions

Current State

The restructuring is happening in phases:

  • Phase 1 (current): Move existing zettelkasten cards to docs/zk/ as a temporary holding area
  • Future phases: Build out the new Diataxis-based structure, migrate relevant content from zk cards, and eventually deprecate or integrate the zk format

Directory Layout

docs/
├── README.md          # This file
└── zk/                # Zettelkasten cards (temporary location during restructuring)
    ├── 1767747119-YCPO.md  # Main blumeops overview card
    └── ...                  # Service-specific cards and notes

Viewing the ZK Cards

To view all blumeops zettelkasten cards:

mise run zk-docs

This displays all cards tagged with blumeops, starting with the main overview card.