Product Decisions This Supports
- In-product guidance vs. external docs.
filament-how-it-works is a Filament panel plugin for surfacing "how it works" explanatory content to admin/back-office users. The decision it informs: do we make operational context available inside the admin UI, or keep pointing non-technical operators at Notion/Confluence and absorb the support tickets?
- Build vs. buy (or rather, build vs. adopt). The alternative is a hand-rolled Filament page, custom infolist, or Blade partial per panel. This package collapses that into a
composer require plus a small amount of config — worth taking if the pattern is repeated across two or more panels or environments.
- Localization as a roadmap unlock. 1.1.0's headline is 17 new locales (ar, az, de, es, fa, fr, hi, it, ja, nl, pl, pt, ru, tr, uk, uz, zh_CN). If you have been deferring an admin rollout to non-English markets because every in-house help page needed manual translation, this removes that excuse. It moves "localized admin onboarding" from a scoped work item to a config task. Note ar/fa are RTL — verify layout behavior before committing to those locales in a launch plan.
- Standardization across a product surface. If you run multiple Filament panels (tenant admin, internal ops, partner portal), this is a candidate for a shared help-content convention, which affects design-system and content-ownership decisions more than it affects code.
- Maturity/dependency posture. Useful as a forcing function for a "small single-maintainer plugin" policy decision. 1.1.0 is almost entirely housekeeping — translations, funding links, CI workflow standardization — which means core behavior is unchanged since 1.0.0. Treat functional risk as unproven rather than proven.
When to Consider This Package
Consider it when:
- You are on Laravel + Filament and your admin users are non-technical operators who need in-context explanation of a workflow, not a link to a wiki.
- You need that guidance in more than one language. The 17-locale drop in 1.1.0 is genuinely the differentiating feature of this release and covers a broad European, MENA, Central Asian, and CJK spread.
- The scope is "explain how this works," not "run a knowledge base." You want a small, removable UI component whose failure mode is a missing panel widget, not a broken checkout.
- You can live with community-maintained licensing and no commercial SLA. The addition of a Buy Me a Coffee sponsor link and FUNDING.yml in this release is a sustainability signal — positive for longevity intent, but also a clear indicator that this is a volunteer-maintained project with a low bus factor.
Look elsewhere when:
- You need actual onboarding orchestration — product tours, tooltips, checklists, progress tracking, per-user completion state. That is a different product category; evaluate dedicated tour/onboarding packages instead.
- You need authoritative, translated, versioned documentation. A plugin widget is not a docs platform, and translated strings from a cross-plugin community i18n initiative should be treated as a first draft, not as vetted copy — plan a native-speaker review for any customer-facing locale.
- You require contractual support, security review artifacts, or a maintained release cadence you can hold someone to.
- The help content is highly dynamic or personalized. Check before adopting whether content is config/static or can be driven per-user; the release notes tell us nothing here, so verify in a spike.
Adoption checklist before committing: confirm Filament major-version compatibility, confirm the license, confirm whether translations are publishable/overridable so you can correct copy, and run the suite in a branch. CI workflows were only standardized in this release, so the presence of a green badge is newer than the code.
How to Pitch It (Stakeholders)
For executives (one paragraph): We are evaluating a small, focused Filament plugin that puts "how it works" guidance directly inside our admin interface, so operators stop leaving the product to read documentation. The 1.1.0 release makes it usable in 17 languages at effectively zero incremental cost — that is the reason to look at it now rather than last quarter. Cost of adoption is a day of engineering, cost of removal is similarly low because it is a UI-layer plugin, and the main risk is not technical but organizational: it is maintained by a single volunteer developer with no commercial support. Recommendation is a time-boxed pilot in one internal panel, not a broad rollout.
For engineering: No breaking changes; 1.0.0 → 1.1.0 is translations plus docs, funding, and CI workflow standardization. Integration is a composer require and standard Filament plugin registration. Two things to verify rather than assume: Filament version compatibility across our panels, and whether the locale files are publishable so we can override copy without forking. The i18n strings arrive via a cross-plugin community contribution — cheap and useful, but we should not treat them as reviewed. RTL locales need a visual pass. Treat the dependency as low-criticality and keep it swappable.
For design/content: This establishes a pattern for in-admin explanatory content. If we adopt it, we should own the source copy in English and treat the 17 shipped locales as fallbacks, not as approved translations.