Skip to content

docs(paths): document XDG-first Zi defaults - #890

Merged
ss-o merged 2 commits into
mainfrom
docs/init-loader-defaults
Aug 28, 2026
Merged

docs(paths): document XDG-first Zi defaults#890
ss-o merged 2 commits into
mainfrom
docs/init-loader-defaults

Conversation

@ss-o

@ss-o ss-o commented Aug 28, 2026

Copy link
Copy Markdown
Member

Closes #887. Closes #889.

Parent: z-shell/.github#553
Project: Z-shell Delivery

What this changes

  • Documents the finalized loader/core ownership boundary and ZI[LOADER_HISTORY].
  • Documents explicit overrides, recognized legacy retention, valid absolute XDG values, and specification fallbacks.
  • Clarifies that ZDOTDIR is not a Zi application-data root.
  • Defines XDG_ZI_* as derived compatibility outputs rather than configuration inputs.
  • Documents both-present diagnostics and the no-automatic-migration boundary, linking the explicit migration follow-up in feat(paths): provide an explicit recoverable XDG home migration zi#429.
  • Updates manual installation examples to reject relative XDG values.
  • Derives active ZPFX examples from ${ZI[HOME_DIR]} while preserving historical recordings.

Publication follows the stable Zi core promotion and src installer merge so the wiki does not describe unshipped behavior as current.

Verification

  • Code-fence and frontmatter validators pass.
  • Plugin Standard validation passes 25/25 tests.
  • pnpm build:en passes with 75 artifacts, 69 canonical documents, 74 link-bearing files, and all corpus evaluations passing.
  • git diff --check passes.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 28, 2026

Copy link
Copy Markdown

Deploying zsh with  Cloudflare Pages  Cloudflare Pages

Latest commit: f1d7dfd
Status: ✅  Deploy successful!
Preview URL: https://6cba81c4.zsh.pages.dev
Branch Preview URL: https://docs-init-loader-defaults.zsh.pages.dev

View logs

@ss-o ss-o changed the title docs(customization): clarify loader-owned defaults docs(paths): document XDG-first Zi defaults Aug 28, 2026
@ss-o ss-o added area:docs Documentation systems, content, or publishing. area:zi Zi core behavior, APIs, or documentation. type:docs Documentation-only work. labels Aug 28, 2026
ss-o added 2 commits August 28, 2026 04:45
The customization table lists every ZI[...] field without saying which
entry point assigns it, so readers could not tell that the loader sets
some values before zi.zsh runs, or that ZI[HOME_DIR] resolves differently
depending on whether the loader is used.

- Note which fields the loader owns and that the rest are derived by
  zi.zsh from those values.
- Record the deliberate ZI[HOME_DIR] divergence: the loader defaults to
  the XDG data path while zi.zsh's own fallback for an unset value is
  ${HOME}/.zi.
- Document ZI[LOADER_HISTORY], the loader-only toggle that suppresses the
  HISTFILE, SAVEHIST, and HISTSIZE defaults.

Pairs with the loader changes in z-shell/src.
@ss-o
ss-o force-pushed the docs/init-loader-defaults branch from 2667f42 to f1d7dfd Compare August 28, 2026 03:45
@ss-o
ss-o merged commit 3c56c28 into main Aug 28, 2026
8 checks passed
@ss-o
ss-o deleted the docs/init-loader-defaults branch August 28, 2026 03:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs Documentation systems, content, or publishing. area:zi Zi core behavior, APIs, or documentation. type:docs Documentation-only work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(customization): loader-owned defaults and ZI[HOME_DIR] divergence undocumented docs(paths): document XDG-first Zi defaults and legacy migration

1 participant