vrr/agent-zero
2
0
Fork 0
mirror of https://github.com/agent0ai/agent-zero.git synced 2026-07-09 17:08:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
agent-zero/plugins/_whats_new/AGENTS.md
Alessandro 0a9e15be87 Disable What's New cards 
Move active What's New content into an empty slide list so the startup modal stays quiet until new cards are added. Keep manual Open available with an empty state, and update the static test plus DOX contract for dormant periods.
2026-07-02 17:29:40 +02:00

2.5 KiB
Raw Permalink Blame History

What's New Plugin DOX

Purpose

  • Own the built-in version-gated "What's New" modal for showcasing Agent Zero features after updates, dormant when no cards are configured.

Ownership

  • plugin.yaml owns metadata and always-enabled status.
  • webui/main.html owns the canonical modal opened by startup and the Builtin Plugins Open button.
  • webui/whats-new.html is a compatibility redirect to webui/main.html.
  • webui/whats-new-slides.js owns the current card list; an empty list disables automatic display.
  • webui/ owns the Alpine store, copy, and showcase media assets.
  • extensions/webui/initFw_end/ owns the startup trigger that opens the modal once per newer installed version when cards exist unless the user has permanently opted out.

Local Contracts

  • Closing, Skip, or Done records only the current installed version as seen.
  • Future updates with cards should auto-open the modal again unless the user checks the modal's permanent opt-out checkbox.
  • Do not auto-open the modal when webui/whats-new-slides.js exports no cards.
  • The permanent opt-out is stored in browser-local state under a0_whats_new_never_show.
  • Honor the legacy a0_whats_new_seen_version browser-local marker as the last seen version.
  • Keep the modal copy concise, left-aligned, and paired with feature media.
  • Keep modal actions in the pinned footer using the shared Agent Zero button classes.
  • Store seen-version and opt-out markers in browser-local state only; do not persist this under usr/.

Work Guidance

  • Add showcase cards in webui/whats-new-slides.js; add assets under webui/assets/ and reference them through /plugins/_whats_new/webui/assets/....
  • Keep the startup extension idempotent and tolerant of missing or non-comparable version labels.
  • Prefer release-line comparisons over development commit-distance comparisons so local development builds do not reopen the modal on every commit.
  • Preserve webui/main.html so the plugin list exposes the standard Open action.

Verification

  • Run pytest tests/test_whats_new_static.py after changing the modal, trigger, or assets.
  • When the card list is empty, smoke-test no startup modal and the manual Builtin Plugins Open empty state when practical.
  • When cards exist, smoke-test startup display, slide navigation, dismissal, same-version reload behavior, newer-version display behavior, opt-out behavior, and manual Builtin Plugins Open behavior in the WebUI.

Child DOX Index

No child DOX files.