eblume/blumeops
1
1
Fork 0
Code Issues Pull requests Projects Releases 83 Packages Wiki Activity Actions

Review exploring-the-docs: fix links, add Related section

Browse source 
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Erich Blume 2026-02-05 12:53:44 -08:00
commit e5cc00f1cc
2 changed files with 17 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/changelog.d/doc-exploring-the-docs-review.doc.md Normal file
View file

@ -0,0 +1 @@
Review and clean up exploring-the-docs tutorial: simplify wiki-links, fix broken replication/ reference, add Related section, match zk-docs flags to CLAUDE.md.

27
docs/tutorials/exploring-the-docs.md
View file

@ -27,8 +27,8 @@ The docs follow the [Diataxis](https://diataxis.fr/) framework:
### 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
- [[how-to]] guides for common operations (deploy, troubleshoot, update ACLs)
- [[reference]] has service URLs, commands, and config locations
- [[ai-assistance-guide]] explains how to work effectively with Claude
- Run `mise run zk-docs` to prime AI context with key documentation
@ -36,30 +36,29 @@ You probably want quick access to operational details:
Context for effective assistance:
- Read [[ai-assistance-guide]] for operational conventions
- [[reference|Reference]] has the technical specifics you'll need
- [[reference]] 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:
- [[explanation|Explanation]] covers the "why" behind design decisions
- [[reference|Reference]] shows what's actually running
- [[explanation]] covers the "why" behind design decisions
- [[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
- [[how-to]] guides for specific tasks (deploy services, add roles)
- [[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
- [[explanation|Explanation]] covers architecture and design rationale
- The `replication/` tutorials go deep on components
- [[replicating-blumeops]] provides the overview, with linked tutorials that go deep on individual components
- [[explanation]] covers architecture and design rationale
- Reference pages show specific configuration choices
## Using Wiki Links
@ -77,7 +76,13 @@ Pre-commit hooks automatically validate that all wiki-links point to existing fi
The `zk-docs` mise task concatenates key documentation files for AI context:
```bash
mise run zk-docs
mise run zk-docs -- --style=header --color=never --decorations=always
```
This outputs the AI assistance guide, reference index, how-to index, architecture overview, and tutorials index - providing Claude with essential context for BlumeOps operations.
## Related
- [[tutorials]] - Parent index of all tutorials
- [[update-documentation]] - How to publish doc changes
- [[review-documentation]] - Periodic doc review process