feat(15): comprehensive README — install, config, every feature, examples#38
Merged
Conversation
There was a problem hiding this comment.
Ship it. Comprehensive docs upgrade — accurate to facades/config, great examples, closes #15 solidly.
- Examples match
@methodblock [from: GitHubReadFile conduit-ui/mattermost:src/Facades/Mattermost.php]. - Config snippet aligns post-#30.
- docker-compose.yml ships as advertised [from: GitHubReadFile].
Nits inline.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Message+Attachmentbuilder, threading, fieldsHandlerbase class with reply/react/typing,#[Middleware]attribute, queueable handlerscontext.actionconventionMattermostStreamingReply::create→ append → finalizetoMattermost,MattermostMessage, broadcast driverMattermost::fake(), full assertion list,MattermostFixturesbuildersTest plan
@methodblock onsrc/Facades/Mattermost.php)src/Messages/Message.phpandsrc/Messages/Attachment.phpsrc/Bot/Middleware/src/Bot/Middleware/Guards/config/mattermost.phpafter feat: vendor:publish config — bootstrap onboarding #30php artisan vendor:publish --tag=mattermost-configreferenced (per feat: vendor:publish config — bootstrap onboarding #30)context.actionshape (per fix(8): read interactive action_id from context, not top-level #36)Closes #15