Reject wiki-links with spaces and fix existing ones
Update doc-links task to detect and reject wiki-links that have spaces in the target or around the pipe separator. Fix all 60 existing links that had spaces (e.g., [[target | Text]] → [[target|Text]]). This ensures compatibility with obsidian.nvim which doesn't handle spaced wiki-links correctly. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
ed24ffdd64
commit
c7a51ae253
30 changed files with 101 additions and 70 deletions
|
|
@ -14,7 +14,7 @@ This tutorial walks through deploying a new service to BlumeOps via ArgoCD, incl
|
|||
|
||||
## Prerequisites
|
||||
|
||||
- Access to the [[tailscale | Tailscale]] network
|
||||
- Access to the [[tailscale|Tailscale]] network
|
||||
- `kubectl` configured with `minikube-indri` context
|
||||
- `argocd` CLI installed (via Brewfile: `brew bundle`)
|
||||
|
||||
|
|
|
|||
|
|
@ -62,9 +62,9 @@ Types (file suffix): `.feature`, `.bugfix`, `.infra`, `.doc`, `.ai`, `.misc`
|
|||
### Wiki-Link Formatting
|
||||
|
||||
Use simple wiki-links without alternate text or extra spaces:
|
||||
- Prefer `[[borgmatic]]` over `[[borgmatic | Borgmatic]]`
|
||||
- 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 ]]`
|
||||
- No spaces around the pipe: `[[path|Text]]` not `[[ path|Text ]]`
|
||||
|
||||
When editing documentation, rewrite links to follow this convention as you encounter them.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue