Skip to content

docs: rename tips subsection to gotchas#16

Merged
zuqini merged 2 commits intomainfrom
zuqini/docs-cleanup
Apr 15, 2026
Merged

docs: rename tips subsection to gotchas#16
zuqini merged 2 commits intomainfrom
zuqini/docs-cleanup

Conversation

@zuqini
Copy link
Copy Markdown
Owner

@zuqini zuqini commented Apr 15, 2026

The "Tips" subsection was nested inside a chapter titled "Tips & Migration", which made :h zpack-tips vs :h zpack-tips-and-migration ambiguous. Its only bullet (vim.pack's quiet install UI) is a gotcha, not a tip, so rename the subsection to "Gotchas" and reword the intro accordingly. Tag *zpack-tips* becomes *zpack-gotchas* and *zpack-tip-install-update* becomes *zpack-gotcha-install-update*; neither tag has any references outside today's commits.

zuqini added 2 commits April 15, 2026 11:07
The "Tips" subsection was nested inside a chapter titled "Tips &
Migration", which made `:h zpack-tips` vs `:h zpack-tips-and-migration`
ambiguous. Its only bullet (vim.pack's quiet install UI) is a gotcha,
not a tip, so rename the subsection to "Gotchas" and reword the intro
accordingly. Tag `*zpack-tips*` becomes `*zpack-gotchas*` and
`*zpack-tip-install-update*` becomes `*zpack-gotcha-install-update*`;
neither tag has any references outside today's commits.
Mirror docs/tips.md's `## Compatibility Notes` wrapper in the vimdoc
by collapsing the former 11.3 SNACKS.NVIM DASHBOARD and 11.4
NOICE.NVIM WITH VIM.PACK into sub-sub-sections of a new 11.3
COMPATIBILITY NOTES. Adds new tag `*zpack-compat-notes*`; existing
`*zpack-tip-snacks*` and `*zpack-tip-noice*` tags are preserved so
the cross-reference from |zpack-gotcha-install-update| still resolves.
@zuqini zuqini merged commit 43e8d65 into main Apr 15, 2026
2 checks passed
@zuqini zuqini deleted the zuqini/docs-cleanup branch April 15, 2026 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant