Skip to content

docs(plugin): update F-Sy-H guide - #900

Merged
ss-o merged 3 commits into
mainfrom
bug-54
Aug 30, 2026
Merged

docs(plugin): update F-Sy-H guide#900
ss-o merged 3 commits into
mainfrom
bug-54

Conversation

@ss-o

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

Copy link
Copy Markdown
Member

Summary

  • document the current F-Sy-H loading and unload contract
  • replace removed fast-theme and FAST_WORK_DIR interfaces with fsh_theme and :fsh:config
  • document theme metadata, accepted colour values, canonical fallbacks, overlays, paths, and optional secondary themes

Validation

  • pnpm validate:frontmatter
  • pnpm validate:code-fences
  • pnpm lint
  • pnpm build:en
  • LLM corpus validation: 84 artifacts from 78 canonical documents

Related: z-shell/F-Sy-H#54
Closes z-shell/F-Sy-H#91
Security advisory: z-shell/F-Sy-H#GHSA-33c2-cgpq-8gpc

@cloudflare-workers-and-pages

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

Copy link
Copy Markdown

Deploying zsh with  Cloudflare Pages  Cloudflare Pages

Latest commit: 44c9c1e
Status: ✅  Deploy successful!
Preview URL: https://4e86c182.zsh.pages.dev
Branch Preview URL: https://bug-54.zsh.pages.dev

View logs

@ss-o

ss-o commented Aug 29, 2026

Copy link
Copy Markdown
Member Author

Heads-up: this documents the pre-v2 F-Sy-H API, which changed on main today.

z-shell/F-Sy-H#101 ("refactor!: align F-Sy-H with plugin standard v2") landed
and renamed the user-facing interface. The additions in this pull request use
the old names:

documented here current on F-Sy-H main
fast-theme fsh_theme
FAST_WORK_DIR zstyle ':fsh:config' work-dir ...
ZSH_HIGHLIGHT_MAXLENGTH zstyle ':fsh:config' max-length ...
FAST_THEME_MANAGER_DISABLED=1 zstyle ':fsh:config' theme-manager disabled
the f-sy-h alias removed

F-Sy-H/README.md:108-125 carries the full migration list, and states that the
legacy names are deliberately not retained as a second compatibility interface.

The sentence about current_theme.zsh and theme_overlay.zsh being sourced
during loading also needs review: the v2 README says executable legacy theme
cache files are no longer loaded and a theme must be reapplied with fsh_theme.

Worth updating before merge so the wiki does not ship instructions that fail on
the current release.

ss-o added 2 commits August 30, 2026 07:57
Replace legacy loading and theme-manager details with the current fsh
contract. Document supported values, metadata, fallback ownership,
overlays, and work-directory paths.

Refs z-shell/F-Sy-H#54
Closes z-shell/F-Sy-H#91
@ss-o ss-o changed the title docs(plugin): document F-Sy-H loading contract docs(plugin): update F-Sy-H guide Aug 30, 2026
@ss-o
ss-o merged commit 713f496 into main Aug 30, 2026
8 checks passed
@ss-o
ss-o deleted the bug-54 branch August 30, 2026 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(themes): theme guide is out of date and omits the colour format

1 participant