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

Add wiki-link formatting convention to AI guide

Browse source 
- Prefer simple links like [[borgmatic]] over [[borgmatic | Borgmatic]]
- Only use alternate text when grammatically warranted
- No spaces around the pipe
- Fix existing links in the guide and backups.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Erich Blume 2026-02-04 07:00:51 -08:00
commit e3daf56582
2 changed files with 12 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/reference/storage/backups.md
View file

@ -35,7 +35,7 @@ Daily automated backups from [[indri]] to [[sifaka | Sifaka]] NAS.
## Sifaka-Native Data
Some data lives directly on [[sifaka | Sifaka]] rather than being backed up to it (photos via [[immich]], music via [[navidrome]], video via [[jellyfin]]). See [[sifaka | Sifaka]] for data protection details.
Some data lives directly on [[sifaka]] rather than being backed up to it (photos via [[immich]], music via [[navidrome]], video via [[jellyfin]]). See [[sifaka]] for data protection details.
## What Is NOT Backed Up

13
docs/tutorials/ai-assistance-guide.md
View file

@ -59,6 +59,15 @@ echo "Description" > docs/changelog.d/branch-name.feature.md
Types (file suffix): `.feature`, `.bugfix`, `.infra`, `.doc`, `.misc`
### Wiki-Link Formatting
Use simple wiki-links without alternate text or extra spaces:
- Prefer `[[borgmatic]]` over `[[borgmatic | Borgmatic]]`
- Only use alternate text when grammatically warranted (e.g., `[[cluster|Kubernetes]]` reads better than `[[cluster]]`)
- No spaces around the pipe: `[[path|Text]]` not `[[ path | Text ]]`
When editing documentation, rewrite links to follow this convention as you encounter them.
## Service Locations
Understanding where services run helps target changes correctly:
@ -66,7 +75,7 @@ Understanding where services run helps target changes correctly:
| Location | Services | Management |
|----------|----------|------------|
| [[indri]] (native) | Forgejo, Zot, Jellyfin, Caddy | Ansible |
| [[cluster | Kubernetes]] | Everything else | ArgoCD |
| [[cluster|Kubernetes]] | Everything else | ArgoCD |
## Mise Tasks
@ -108,7 +117,7 @@ For AI agents building context:
Credentials live in 1Password. Never retrieve them directly - use existing patterns:
- Ansible `pre_tasks` gather secrets at playbook start
- [[external-secrets|External Secrets]] syncs to Kubernetes
- [[external-secrets]] syncs to Kubernetes
- Scripts use `op` CLI with user biometric prompts
## Common Pitfalls