Erich Blume
db0512b5d4
## Doc review (5 stalest, all never-reviewed) Each card was verified against live state (ArgoCD app list/health, manifests, 1Password item fields, Mealie API probe) and stamped `last-reviewed: 2026-06-09`. | Card | Findings fixed | |------|----------------| | `reference/services/argocd.md` | Added Authentik SSO (public PKCE client, `--sso` login, admins→role:admin RBAC); documented dual-cluster management (minikube + ringtail k3s at `ringtail.tail8d86e.ts.net:6443`); corrected sync policy — the `apps` root is **manual**, not automated | | `reference/services/authentik.md` | Blueprint list grown from 5 to 10 files; OIDC client table now lists all 8 clients with types; secrets table updated to `postgresql-*` fields and per-client secrets | | `reference/services/grafana.md` | TeslaMate datasource moved to `pg.ops.eblu.me:5434` (ringtail); dashboard inventory refreshed (20 provisioned ConfigMaps); TeslaMate dashboards documented as init-container fetch from forge mirror at pinned tag; SSO role mapping wording corrected (Admin only for `admins` group) | | `reference/infrastructure/unifi.md` | UnPoller image is now locally built (`registry.ops.eblu.me/blumeops/unpoller`); verified namespace/port | | `how-to/mealie/plan-a-meal.md` | Procedure verified; **found the stored API token (`op://blumeops/mealie/credential`) returns 401** — operational fix in progress, doc content unchanged | ## AGENTS.md - **Scaled back the ai-docs rule** (per discussion): agents now start by finding and reading relevant docs; `mise run ai-docs` (~130K tokens now) and `ai-sources` become opt-in bulk loads. `agent-change-process.md` updated to match. The `ai-docs` mise task itself is kept for now — happy to retire it in a follow-up if desired. - **Documented the heph CLI** task workflow (list/show/context/log read paths; done/drop/skip/log/edit/task write paths) so future sessions can read and manipulate Blumeops tasks without rediscovery. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Reviewed-on: #373
82 lines
3.2 KiB
Markdown
82 lines
3.2 KiB
Markdown
---
|
|
title: Exploring the Docs
|
|
modified: 2026-06-09
|
|
tags:
|
|
- tutorials
|
|
- getting-started
|
|
---
|
|
|
|
# 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](https://diataxis.fr/) framework:
|
|
|
|
| Section | Purpose | When to Use |
|
|
|---------|---------|-------------|
|
|
| **[Tutorials](/tutorials/)** | Learning-oriented | "I'm new and want to understand" |
|
|
| **[Reference](/reference/)** | Information-oriented | "I need specific technical details" |
|
|
| **[How-to](/how-to/)** | Task-oriented | "I need to do X" |
|
|
| **[Explanation](/explanation/)** | Understanding-oriented | "I want to understand why" |
|
|
|
|
## Quick Paths by Audience
|
|
|
|
### For Erich (Owner)
|
|
|
|
You probably want quick access to operational details:
|
|
- [How-to](/how-to/) guides for common operations (deploy, troubleshoot, update ACLs)
|
|
- [Reference](/reference/) has service URLs, commands, and config locations
|
|
- [[ai-assistance-guide]] explains how to work effectively with AI agents
|
|
|
|
### For AI Agents
|
|
|
|
Context for effective assistance:
|
|
- Read [[ai-assistance-guide]] for operational conventions
|
|
- [Reference](/reference/) has the technical specifics you'll need
|
|
- The repo's `AGENTS.md` has critical rules (especially the kubectl context requirement)
|
|
|
|
### For External Readers
|
|
|
|
Understanding what this is:
|
|
- [Explanation](/explanation/) covers the "why" behind design decisions
|
|
- [Reference](/reference/) shows what's actually running
|
|
- Browse service pages to see specific implementations
|
|
|
|
### For Contributors
|
|
|
|
Getting started with changes:
|
|
- [[contributing]] walks through the workflow
|
|
- [How-to](/how-to/) guides for specific tasks (deploy services, add roles)
|
|
- [Reference](/reference/) 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, with linked tutorials that go deep on individual components
|
|
- [Explanation](/explanation/) covers architecture and design rationale
|
|
- Reference pages show specific configuration choices
|
|
|
|
## Using Wiki Links
|
|
|
|
Documentation uses `[[wiki-links]]` for cross-references:
|
|
- `[[service-name]]` links by filename stem (must be unambiguous)
|
|
- `[[path/to/file]]` links by path from docs root (for disambiguation)
|
|
- `[[page|Display Text]]` customizes the link text
|
|
|
|
When reading on the web (docs.eblu.me), these render as clickable links. The backlinks panel shows what references each page.
|
|
|
|
Prek hooks validate that all wiki-links resolve to existing files and flag ambiguous bare-name links.
|
|
|
|
## AI Context Priming
|
|
|
|
AI agents prime themselves by searching `docs/` for cards relevant to the task at hand and following wiki-links from there. (The retired `ai-docs` mise task used to concatenate every doc for this purpose, but the corpus outgrew a context window.) For deep codebase questions, `mise run ai-sources` concatenates all non-doc source files.
|
|
|
|
## Related
|
|
|
|
- [[update-documentation]] - How to publish doc changes
|
|
- [[review-documentation]] - Periodic doc review process
|