Skip to content

Standardize all plugin READMEs to PLUGIN-STANDARD#35

Merged
rmyndharis merged 1 commit into
mainfrom
docs/standardize-plugin-readmes
Jul 12, 2026
Merged

Standardize all plugin READMEs to PLUGIN-STANDARD#35
rmyndharis merged 1 commit into
mainfrom
docs/standardize-plugin-readmes

Conversation

@rmyndharis

Copy link
Copy Markdown
Owner

What & why

Every plugin README now follows PLUGIN-STANDARD.md end to end — the badge row (type / license / OpenWA compatibility), a blockquote tagline, and the full required section set (Details → Features → behavior → Setup → Install → Configuration → Compatibility → Security → Changelog → License). A heading-only glance had masked several gaps; this pass reads each README in full and closes them.

Changes

Plugin What was missing / off
typebot-connector Full rewrite — previously only Details + "How it works" + "Setup" + "Notes & limits". Added badges, tagline, Features, Install, Configuration, Compatibility, Security, Changelog, License.
chatwoot-adapter Added the badge row, blockquote tagline, and an Install section.
supabase-otp-hook Added the badge row and blockquote tagline; reordered Setup before Install.
after-hours Added Security and Setup sections.
chat-flow, faq-bot, group-translate, http-action Added a Setup section.
http-action Set minOpenWAVersion: 0.8.7 (allowConfigHosts + conversation:send) so the OpenWA badge shows a real value; testedOpenWAVersion left unset (still development).

Verification

  • npm run catalog:check — up to date (10 plugins).
  • npm run typecheck — clean.
  • npm test — 395/395 passing.

Notes

  • catalog:check enforces only the generated Details block and version↔changelog drift, not the full section list, which is why the larger gaps (notably typebot-connector) had gone unnoticed. This PR is the manual sweep that gate doesn't cover.
  • http-action is status: development and not yet tested on a real instance, so testedOpenWAVersion is intentionally left unset rather than guessed.

Bring every plugin README into line with PLUGIN-STANDARD.md — the badge row (type /
license / OpenWA compatibility), a blockquote tagline, and the full required section set
(Details, Features, behavior, Setup, Install, Configuration, Compatibility, Security,
Changelog, License). A heading-only glance had masked several gaps; this pass reads each
README in full and closes them.

- typebot-connector: full rewrite — previously only a Details block, "How it works",
  "Setup", and "Notes & limits". Added badges, tagline, Features, Install, Configuration,
  Compatibility, Security, Changelog, License.
- chatwoot-adapter: added the badge row, blockquote tagline, and an Install section.
- supabase-otp-hook: added the badge row and blockquote tagline; reordered Setup before
  Install.
- after-hours: added a Security section and a Setup section.
- chat-flow, faq-bot, group-translate, http-action: added a Setup section.
- http-action: set minOpenWAVersion 0.8.7 (allowConfigHosts + conversation:send) so the
  OpenWA badge carries a real value; testedOpenWAVersion left unset (still development).

Catalog regenerated. catalog:check, typecheck, and the full test suite (395) all pass.
@rmyndharis rmyndharis merged commit 1f4f69a into main Jul 12, 2026
1 check passed
@rmyndharis rmyndharis deleted the docs/standardize-plugin-readmes branch July 12, 2026 00:44
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.

1 participant