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>
This commit is contained in:
parent
50046f42f8
commit
1e4e72b923
18 changed files with 620 additions and 120 deletions
|
|
@ -41,20 +41,20 @@ Context for effective assistance:
|
|||
### For External Readers
|
||||
|
||||
Understanding what this is:
|
||||
- [[what-is-blumeops]] gives the high-level overview
|
||||
- [[reference/index|Reference]] 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|Reference]] tells you where things live
|
||||
- The `CLAUDE.md` in the repo root has contribution rules
|
||||
|
||||
### For Replicators
|
||||
|
||||
Building your own:
|
||||
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
|
||||
|
|
@ -64,10 +64,12 @@ Building your own:
|
|||
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
|
||||
- `[[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.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue