Skip to content

docs: rename tips subsection to gotchas #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zuqini merged 2 commits into from
Apr 15, 2026
Merged

docs: rename tips subsection to gotchas #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb29e56
docs: rename tips subsection to gotchas
zuqini Apr 15, 2026
857fd06
docs: group snacks + noice compat tips under 11.3
zuqini Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions doc/zpack.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/tips.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading