Repository navigation
[docs]: update the Zsh Lint guide for v1.6.1 #949
Description
Description
The Zsh Lint reader guide under community/04_zsh_lint/ describes v1.6.0: index.mdx, 01_getting_started.mdx, 05_ci_and_json.mdx and 07_parser_survey.mdx install @v1.6.0, and 01_getting_started.mdx, 02_choosing_files.mdx and 06_troubleshooting.mdx describe behaviour "in v1.6.0". The next zsh-lint release is v1.6.1 (z-shell/zsh-lint#751), a patch release with rule and parser fixes and no new options.
Acceptance criteria:
- The install commands and the statements that describe the current release name
v1.6.1. Statements about the release in which a behaviour changed, such as--helpbeforev1.6.0or configuration discovery sincev1.3.0, keep their version. - Each statement attributed to
v1.6.1is checked against thev1.6.1source. Where the guide describes the affected rules, it matches the fixes in the release: declarations afterbuiltin,noglob,-andnocorrect([bug]: a declaration after builtin, noglob, - or nocorrect is missed by the declaration rules zsh-lint#688) and the subscript advice ofquoting/unquoted-var([bug]: quoting/unquoted-var gives array advice for a single subscripted element zsh-lint#747). - The generated rule reference (
08_rule_reference.mdx) is excluded; the zsh-lint release sync owns it. - This change merges only after
v1.6.1is published, so the guide never names an unreleased version.
Select the area that is associated with this issue.
Other
Contact Details
Not applicable: maintainer-filed.
Metadata
Metadata
Assignees
Type
Projects
- Status
Activity
ss-o commentedon Oct 24, 2026
Triage: Item Type Docs, Impact Low, Effort S, Priority P3 - Low, Workstream Human delivery, labels
type:docsandarea:docs, status Blocked withstatus:blocked.v1.6.1only after that release is published.v1.6.0stays installable and its guide stays accurate for it until this change lands.Next action: once
v1.6.1is published, update the guide and open a pull request that closes this issue.ss-o commentedon Oct 25, 2026
Started now that z-shell/zsh-lint v1.6.1 is published (z-shell/zsh-lint#751, tag commit
136df813e37d0ec48573929489b44c1841af57ee).Next action: update the install commands and current-release statements in
index.mdx,01_getting_started.mdx,02_choosing_files.mdx,05_ci_and_json.mdx,06_troubleshooting.mdxand07_parser_survey.mdxtov1.6.1, check each statement against thev1.6.1source and binary, keep release-history statements at their versions, leave08_rule_reference.mdxto the release sync (#950), and open a pull request that closes this issue.