Skip to content

feat(15): comprehensive README — install, config, every feature, examples#38

Merged
jordanpartridge merged 1 commit into
mainfrom
feat/15-readme
Apr 27, 2026
Merged

feat(15): comprehensive README — install, config, every feature, examples#38
jordanpartridge merged 1 commit into
mainfrom
feat/15-readme

Conversation

@jordanpartridge
Copy link
Copy Markdown
Contributor

Summary

Closes #15 (README portion — a full GitHub Pages docs site can come later from the same source if/when we want it).

Expands the README from ~40 lines (title + bullet list + install snippet) to ~525 lines covering every shipping feature with real, copy-pasteable examples sourced from the actual facade signatures, builder methods, and config keys.

What's covered

  • Setup — install, vendor:publish, minimum env vars
  • Configuration — connections, bot middleware, slash commands
  • REST API client — every facade resource (posts/channels/users/teams/files/reactions/bots/webhooks/commands/emoji/status/system) with usage
  • Sending messages — fluent Message + Attachment builder, threading, fields
  • Bot framework — handler registration (class/name/wildcard), Handler base class with reply/react/typing, #[Middleware] attribute, queueable handlers
  • Middleware — built-in table (IgnoreBots, Dedup, RateLimit, ChannelFilter, AdminOnly), how to write custom
  • Guards — RequiresRole, RequiresPermission, ChannelMember
  • Slash commands — registration, handlers, in_channel/ephemeral responses
  • Interactive messages — action handler registration, button payload shape, context.action convention
  • Streaming repliesMattermostStreamingReply::create → append → finalize
  • NotificationstoMattermost, MattermostMessage, broadcast driver
  • Filament panel — plugin registration + page list
  • Artisan commands — listen / post / health
  • TestingMattermost::fake(), full assertion list, MattermostFixtures builders
  • Multi-server — named connections, per-call selection
  • Local development — docker compose + integration test suite

Test plan

Closes #15

@jordanpartridge jordanpartridge merged commit 4352680 into main Apr 27, 2026
4 checks passed
Copy link
Copy Markdown

@lexi-chief-of-staff lexi-chief-of-staff Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ship it. Comprehensive docs upgrade — accurate to facades/config, great examples, closes #15 solidly.

  • Examples match @method block [from: GitHubReadFile conduit-ui/mattermost:src/Facades/Mattermost.php].
  • Config snippet aligns post-#30.
  • docker-compose.yml ships as advertised [from: GitHubReadFile].

Nits inline.

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: Documentation site + comprehensive README

1 participant