-
Notifications
You must be signed in to change notification settings - Fork 0
Adds first drafts to the /docs (they are rough and probably have a lot of missing information) #21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…t of missing information) Signed-off-by: Joey Smith <jsmith@webinertia.net> Signed-off-by: Joey Smith <jsmith@webinertia.net>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds the first draft of comprehensive documentation for the cmd-bus library, providing detailed documentation for core components, interfaces, middleware, handlers, exceptions, and container factories.
- Adds documentation for all major components including CmdBus, MiddlewarePipe, CommandHandlerFactory, and ConfigProvider
- Provides extensive usage examples, configuration guides, and best practices throughout the documentation
- Includes a complete getting started guide with step-by-step setup instructions and integration examples
Reviewed Changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/middleware/command-handler-middleware.md | Documents the final middleware that resolves and executes command handlers |
| docs/middleware-pipe.md | Documents the core middleware pipeline implementation and execution flow |
| docs/middleware-interface.md | Documents the contract for middleware components with usage examples |
| docs/handler/empty-pipeline-handler.md | Documents the fallback handler for unhandled commands |
| docs/getting-started.md | Comprehensive setup guide with examples, testing, and troubleshooting |
| docs/exception/next-handler-already-called-exception.md | Documents exception for pipeline state errors |
| docs/exception/invalid-configuration-exception.md | Documents configuration-related exception handling |
| docs/exception/command-exception.md | Documents the base exception for command processing errors |
| docs/container/cmdbus-factory.md | Documents the service factory for CmdBus with integration examples |
| docs/config-provider.md | Documents the Laminas configuration provider and service registration |
| docs/command-interface.md | Documents the basic contract for commands |
| docs/command-handler-interface.md | Documents the contract for command handlers |
| docs/command-handler-factory.md | Documents the factory for resolving command handlers with extensive examples |
| docs/cmdbus.md | Documents the main command bus implementation |
| docs/cmdbus-interface.md | Documents the core command bus contract |
| docs/README.md | Provides documentation index and architecture overview |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Signed-off-by: Joey Smith jsmith@webinertia.net
Signed-off-by: Joey Smith jsmith@webinertia.net