Skip to content

docs: add .prettierrc and decide the README template shape for the manager #538

Description

@ss-o

Problem

Two Markdown hygiene gaps found during the zi repository-health evaluation of 2026-09-18:

  1. The repository has no .prettierrc. runbooks/new-repository.md in 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.
  2. The root README.md follows 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 no docs/README.md although docs/ 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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:ziZi core behavior, APIs, or documentation.type:docsDocumentation-only work.

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions