docs(mcms): add proposal analysis package usage docs#799
docs(mcms): add proposal analysis package usage docs#799graham-chainlink wants to merge 1 commit intomainfrom
Conversation
|
There was a problem hiding this comment.
Pull request overview
Adds package-level GoDoc documentation for the MCMS proposal analysis engine and its extension points (analyzers/renderers) to make the engine workflow and customization model easier to discover.
Changes:
- Added end-to-end engine usage flow documentation for creating an engine, registering analyzers/renderers, running analysis, and rendering output.
- Added analyzer extension-point documentation with a concrete
ProposalAnalyzerexample. - Added renderer extension-point documentation with a concrete custom renderer example.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| engine/cld/mcms/proposalanalysis/doc.go | Documents the overall engine workflow and a full usage example. |
| engine/cld/mcms/proposalanalysis/analyzer/doc.go | Documents analyzer interfaces/extension points and an example analyzer implementation. |
| engine/cld/mcms/proposalanalysis/renderer/doc.go | Documents renderer interface/extension point and an example renderer implementation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Document how to create and run the proposal analysis engine, and how to implement custom analyzers and renderers so teams can integrate the extension points consistently.
graham-chainlink
force-pushed
the
ggoh/OPT-409/add-proposalanalysis-docs
branch
from
9ac4d55 to
a251f13
Compare
|
| @@ -0,0 +1,74 @@ | |||
| /* | |||
| Package analyzer defines analyzer interfaces used by the proposal analysis engine. | |||
There was a problem hiding this comment.
It would be nice to also add a page on the docs/ folder with similar information and examples.
There was a problem hiding this comment.
yeah deciding on this, will see how we go, maybe we will add a more official page on the docs.cld too
What changed
doc.gotoengine/cld/mcms/proposalanalysiswith an end-to-end engine usage flow: create engine, register analyzers, register renderer, run analysis, and render withRenderTo.analyzer/doc.godescribing analyzer extension points and a concrete customProposalAnalyzerimplementation example.renderer/doc.godescribing renderer extension points and a concrete custom renderer implementation example.Why
These docs make the proposal analysis extension model discoverable and consistent, so engineers can implement and wire custom analyzers/renderers without reverse-engineering tests and internals.