From bb29e563b3306567a572b2f9baa48fa2edf85742 Mon Sep 17 00:00:00 2001 From: zuqini Date: Wed, 15 Apr 2026 11:07:22 +0000 Subject: [PATCH 1/2] docs: rename tips subsection to gotchas 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. --- doc/zpack.txt | 6 +++--- docs/tips.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/zpack.txt b/doc/zpack.txt index 241ba7d..e3f591a 100644 --- a/doc/zpack.txt +++ b/doc/zpack.txt @@ -880,11 +880,11 @@ default lazy plugins lazy.nvim's community specs silently default default. ------------------------------------------------------------------------------ -11.2 TIPS *zpack-tips* +11.2 GOTCHAS *zpack-gotchas* -General tips and gotchas when using zpack: +Known gotchas when using zpack: - *zpack-tip-install-update* + *zpack-gotcha-install-update* install/update feedback `vim.pack` surfaces install/update progress via `:messages` (e.g. "vim.pack: Downloading updates (0/83)"). These messages are hidden diff --git a/docs/tips.md b/docs/tips.md index 59fec26..8545f9e 100644 --- a/docs/tips.md +++ b/docs/tips.md @@ -8,9 +8,9 @@ Most of your lazy.nvim plugin specs will work as-is with zpack. However, zpack f - **profiling**: Use `nvim --startuptime startuptime.log`. Also refer to example [Neovim Profiler script](https://gist.github.com/zuqini/35993710f81983fbfa6baca67bdb32ed) - **default lazy plugins**: lazy.nvim's community specs silently default top-level specs for utility libraries like `plenary.nvim` to `lazy = true`, even without lazy triggers or a lazy parent. zpack respects your specs as-written, so set `lazy = true` explicitly on such specs if you want the same default -## Tips +## Gotchas -General tips and gotchas when using zpack: +Known gotchas when using zpack: - **install/update feedback**: `vim.pack` surfaces install/update progress via `:messages` (e.g. `vim.pack: Downloading updates (0/83)`). These messages are hidden if you have `vim.opt.cmdheight = 0` — raise it, check `:messages`, or route them through a notifier like [snacks.notifier](https://github.com/folke/snacks.nvim), [nvim-notify](https://github.com/rcarriga/nvim-notify), or [noice.nvim](https://github.com/folke/noice.nvim). Also see [noice.nvim with vim.pack](#noicenvim-with-vimpack) for compatibility notes ## Compatibility Notes From 857fd06e790dda322812033c7b0b7c61118d6118 Mon Sep 17 00:00:00 2001 From: zuqini Date: Wed, 15 Apr 2026 11:11:05 +0000 Subject: [PATCH 2/2] docs: group snacks + noice compat tips under 11.3 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. --- doc/zpack.txt | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/doc/zpack.txt b/doc/zpack.txt index e3f591a..9749429 100644 --- a/doc/zpack.txt +++ b/doc/zpack.txt @@ -898,7 +898,13 @@ install/update feedback `vim.pack` surfaces install/update progress notes. ------------------------------------------------------------------------------ -11.3 SNACKS.NVIM DASHBOARD *zpack-tip-snacks* +11.3 COMPATIBILITY NOTES *zpack-compat-notes* + +Workarounds for third-party plugins that assume lazy.nvim or filter out +`vim.pack` messages. + + *zpack-tip-snacks* +SNACKS.NVIM DASHBOARD ~ The default Snacks.nvim dashboard configuration includes a startup time section that has a hard dependency on lazy.nvim. This will cause errors with @@ -918,8 +924,8 @@ To work around this, remove the startup section from your dashboard config: < See: https://github.com/folke/snacks.nvim/issues/1778 ------------------------------------------------------------------------------- -11.4 NOICE.NVIM WITH VIM.PACK *zpack-tip-noice* + *zpack-tip-noice* +NOICE.NVIM WITH VIM.PACK ~ noice.nvim filters out `vim.pack` messages by default, which means you won't see install/update notifications from your plugin manager.