Skip to content

docs(paths): document XDG-first Zi defaults and legacy migration #887

Description

@ss-o

Summary

Document the finalized XDG-first Zi path behavior, legacy preservation, and explicit migration workflow in the canonical wiki.

Deliverables

  • Keep the customization path table synchronized with the implemented resolver.
  • Explain precedence: explicit ZI[...], detected legacy installation, valid absolute XDG value, then XDG specification fallback.
  • Document that ZDOTDIR is not a Zi application-data root.
  • Add a legacy-installation section explaining why $HOME/.zi may remain active and how users can opt into migration.
  • Document the both-roots-present diagnostic and recovery steps.
  • Review active examples for misleading hard-coded $HOME/.zi defaults while preserving clearly historical terminal recordings where source fidelity matters.
  • Link to the migration feature issue until an automated command is released.

Verification

  • Check all path examples against the finalized Zi and src behavior.
  • Run the wiki's existing documentation checks.
  • Verify links and anchors.

Dependency

Final wording depends on the Zi core resolver and installer reconciliation. Drafting may begin earlier, but publication must not describe unshipped behavior as current.

Next action

Inventory the active installation and customization pages that state a default path and prepare a synchronized update after the resolver lands.

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:docsDocumentation systems, content, or publishing.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