Skip to content

turboBasic/zinit-doc

Repository files navigation

zinit-doc

A structured Knowledge Base about Zinit — the flexible Zsh plugin manager. Contains 574 Knowledge Cards covering every documented aspect of Zinit: ice modifiers, commands, architecture concepts, annexes, packages, recipes, and real-world troubleshooting patterns extracted from the full issue and discussion history.

Intended as a reference corpus for AI harnesses (RAG pipelines, context injection) and as a browsable human reference.


Card categories

Category Cards Description
ices 56 Ice modifiers (wait'', lucid, from'', as'', …)
commands 47 zi subcommands (load, light, snippet, update, …)
concepts 20 Architecture, turbo mode, completions, OMZ compat, patterns
annexes 11 Annex overview cards + per-annex ice documentation
packages 22 zi pack — curated package cards
recipes 38 Ready-to-use configs for popular CLI programs
installation 5 Install, verify, and uninstall flows
migration 4 Migrating from Oh-My-Zsh, Antigen, Zplug
troubleshooting 371 Bug patterns, workarounds, and Q&A from issues and discussions

Card format

Every card is a Markdown file with YAML front-matter:

---
id: wait
title: "Ice: wait''"
category: ices
tags: [ice, turbo, lazy-loading, performance]
source: https://github.com/zdharma-continuum/zinit/blob/main/README.md
related: [lucid, turbo-mode, ice-order]
---

Followed by structured sections: Summary, Syntax / Usage, Details, Examples, and optional Caveats / Common Mistakes and See Also.


Site

The cards are also published as a browsable site at https://zinit.turbobasic.dev. See site/README.md for build, development, and deployment instructions.


For AI harnesses

See docs/ai-instructions.md for the full card schema, generation rules, tag vocabulary, and source material index. That file is the single source of truth for all AI tooling working with this repository.


Zinit project links

Resource URL
Source code zdharma-continuum/zinit
README / docs zinit README
Wiki Zinit Wiki
Issues GitHub Issues
Discussions GitHub Discussions
Packages zinit-packages
Recipes Recipes for popular programs
Annexes Zinit-related projects

About

A structured Knowledge Base about Zinit — Zsh plugin manager

Topics

Resources

Stars

Watchers

Forks

Contributors