Erich Blume 1e4e72b923 Address PR review feedback for Phase 3 tutorials

Tutorial changes:
- Replace what-is-blumeops with adding-a-service tutorial
- Update ai-assistance-guide with Mise Tasks table
- Update contributing with tooling setup, target revisions, DNS preview
- Remove AI-only sections from contributing and exploring-the-docs
- Add replicator explanation to exploring-the-docs
- Add pre-commit link validation note
- Add Core Services phase to replication roadmap
- Add docs service to services list in replicating-blumeops

New reference cards:
- docs.md - Quartz documentation service
- tailscale-operator.md - Kubernetes ingress operator
- ansible/roles.md - Available ansible roles

Other updates:
- Add mise to Brewfile
- Update docs/index.md to link to exploring-the-docs
- Add notes to update exploring-the-docs in future phases
- Link tailscale-operator from apps.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

2026-02-03 18:50:51 -08:00

2.7 KiB

Raw Blame History

title

Exploring the Documentation

Audiences: All (Owner, AI, Reader, Contributor, Replicator)

This guide explains how the BlumeOps documentation is organized and how to find what you need.

Documentation Structure

The docs follow the Diataxis framework:

Section	Purpose	When to Use
**[[tutorials/index	Tutorials]]**	Learning-oriented
**[[reference/index	Reference]]**	Information-oriented
How-to (planned)	Task-oriented	"I need to do X"
Explanation (planned)	Understanding-oriented	"I want to understand why"

Quick Paths by Audience

For Erich (Owner)

You probably want quick access to operational details:

reference/index has service URLs, commands, and config locations
The zk-docs mise task still works for legacy zettelkasten access
ai-assistance-guide explains how to work effectively with Claude

For Claude/AI Agents

Context for effective assistance:

Read ai-assistance-guide for operational conventions
reference/index has the technical specifics you'll need
The repo's CLAUDE.md has critical rules (especially the kubectl context requirement)

For External Readers

Understanding what this is:

reference/index shows what's actually running
Browse service pages to see specific implementations
The repo's README has project context

For Contributors

Getting started with changes:

contributing walks through the workflow
reference/index tells you where things live

For Replicators

Replicators are people who want to build their own similar homelab GitOps setup, using BlumeOps as inspiration.

replicating-blumeops provides the overview
The replication/ tutorials go deep on components
Reference pages show specific configuration choices

Using Wiki Links

Documentation uses [[wiki-links]] for cross-references:

[[service-name]] links to a reference page
[[folder/page]] links to nested pages
[[page | Display Text]] customizes the link text

When reading on the web (docs.ops.eblu.me), these render as clickable links. The backlinks panel shows what references each page.

Pre-commit hooks automatically validate that all wiki-links point to existing files and that link targets are unambiguous.

Legacy Content

The docs/zk/ directory contains zettelkasten cards from before the restructuring. These are read-only reference - new content goes in the structured sections. The cards will eventually be migrated or archived.

To view legacy cards:

mise run zk-docs

2.7 KiB Raw Blame History