Document the Paramore.Brighter core assembly architecture for new contributors#3648
Conversation
|
|
There was a problem hiding this comment.
Gates Passed
6 Quality Gates Passed
See analysis details in CodeScene
Quality Gate Profile: Clean Code Collective
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.
Co-authored-by: iancooper <45537+iancooper@users.noreply.github.com>
There was a problem hiding this comment.
Gates Passed
6 Quality Gates Passed
See analysis details in CodeScene
Quality Gate Profile: Clean Code Collective
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.
There was a problem hiding this comment.
Gates Passed
6 Quality Gates Passed
See analysis details in CodeScene
Quality Gate Profile: Clean Code Collective
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.
…tributors (BrighterCommand#3648) * Initial plan * Complete comprehensive Paramore.Brighter core architecture guide Co-authored-by: iancooper <45537+iancooper@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: iancooper <45537+iancooper@users.noreply.github.com>
This PR adds comprehensive documentation for the Paramore.Brighter core assembly to help new contributors understand the internal architecture and design decisions.
What's Added
Created
docs/guides/paramore_brighter_core_guide.md- a comprehensive 1,278-line guide covering:Core Architecture
CommandProcessororchestrates request handlingIHandleRequeststoRequestHandler<T>base classesDispatch Mechanisms Deep Dive
Each dispatch method is documented with PlantUML diagrams and implementation details:
Advanced Features
DepositPost/ClearOutboxBrighterSynchronizationContextfor async operation managementDevelopment Guidance
Focus on "Under the Hood"
The guide specifically focuses on implementation details that would help contributors understand:
Code Examples
Includes practical examples throughout:
This documentation complements existing user-facing docs and Contributing.md by providing the architectural context needed to make informed changes to the Brighter codebase.
Fixes #3647.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.