Repository navigation
docs: add .prettierrc and decide the README template shape for the manager #538
Description
Problem
Two Markdown hygiene gaps found during the zi repository-health evaluation of 2026-09-18:
- The repository has no
.prettierrc.runbooks/new-repository.mdin z-shell/.github expects every repository to carry{ "proseWrap": "never" }so Trunk's prettier keeps prose one paragraph per line (.github/instructions/documentation.instructions.md). The README is already written one paragraph per line, so this is a guard, not a reflow. - The root
README.mdfollows a zi-specific shape (Quick start, Learn by task, Community and support, ...), not the organization README template's section map (templates/readme/zsh-plugin.md), and there is nodocs/README.mdalthoughdocs/exists. zi is the plugin manager, not a plugin, so the template's Installation, Lifecycle, and Portable shell contract sections do not map one to one.
Decision needed
- Add
.prettierrc(mechanical, its own pull request). - Decide whether zi's README adopts the template structure with a
docs/README.md(as annexes and tools did through README template guidance does not reach annex, tool, or module READMEs and conflicts with the .prettierrc runbook .github#624), or is recorded as the deliberate exception for the manager. Either way, document the outcome so the next README rewrite does not re-open the question.
Activity
docs: reflow hard-wrapped prose to one paragraph per line
chore(trunk): keep prettier off the delivered review skill
ss-o commentedon Oct 1, 2026
Project 28 triage pass (2026-10-02): stays in
Triage.nextat3fa8433(premise confirmed): Item 1 is done: .prettierrc with{ "proseWrap": "never" }is on next@3fa8433 and on main@4f2c0a7 (merged PR chore(docs): add .prettierrc with proseWrap never #541, promoted by chore: promote next to main #567). Item 2 is open: README.md keeps the zi-specific sections (Quick start, Learn by task, Community and support, ...), docs/ holds only CONTRIBUTING.md, images, man; no docs/README.md and no recorded decision on the template exception found in AGENTS.md, README.md or docs/.ss-o commentedon Oct 7, 2026
Agent handoff
Implemented locally on
feature-538-readme-design, based onnext: the landing page adoptsdocs/README.mdwith corrected relative links, concise features and requirements, a first-use path, and links to manager references. The installer event protocol links to its existing contract inz-shell/srcinstead of interrupting onboarding. The shared plugin-manager adaptation is tracked in z-shell/.github#756.The issue's original
proseWrap: neverrecommendation is superseded by the current organization guidance..prettierrcnow selectspreserve; a focused check with the repository's Prettier 3.6.2 reproduces alert-line collapse underneverand confirms preservation underpreserve. The README also avoids the unqualified light-mode tracking claim disputed in #586.Validation: Markdownlint and Prettier pass; relative paths and shell snippet syntax pass. GitHub's Markdown API renders the alert, and local Chromium previews using GitHub Markdown CSS at 1280 and 375 CSS pixels have no page-wide horizontal overflow. Relative image assets are embedded for the local preview; this is not a published GitHub-page inspection. The installer was not executed.
Next: review and publish the local change to
next; promotion tomainremains a separate release action. No commit or pull request has been published.github-actions commentedon Oct 8, 2026
Released to
mainby promotion #617; the fix merged intonextin #592.