fix(mcms/proposal-analyzer): collapsible fenced blocks for proposal parameters#889
fix(mcms/proposal-analyzer): collapsible fenced blocks for proposal parameters#889graham-chainlink wants to merge 1 commit intomainfrom
Conversation
🦋 Changeset detectedLatest commit: 091d1d0 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
graham-chainlink
force-pushed
the
ggoh/mcms-proposal-parameter-markdown
branch
from
82fe8e3 to
dfb5066
Compare
graham-chainlink
changed the title
There was a problem hiding this comment.
Pull request overview
Updates the MCMS proposal analysis Markdown renderer to display all parameter values consistently as fenced text blocks, wrapped in collapsible sections (open by default) to improve readability of structured inputs.
Changes:
- Render every parameter value as a fenced ````text` block (no more inline rendering).
- Wrap each parameter value in
<details open><summary>…</summary> … </details>for collapsible viewing. - Update golden testdata and E2E expected Markdown output; remove the now-unused
hasNewlinetemplate helper.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| engine/cld/mcms/proposalanalysis/renderer/testdata/golden_markdown.md | Updates golden output to match new collapsible fenced rendering for all parameters. |
| engine/cld/mcms/proposalanalysis/renderer/templates/markdown/parameter.tmpl | Implements always-fenced parameter rendering and wraps values in collapsible <details open> blocks. |
| engine/cld/mcms/proposalanalysis/renderer/funcmap.go | Removes hasNewline from the template func map and deletes the helper implementation. |
| engine/cld/mcms/proposalanalysis/engine_test.go | Updates E2E Markdown expectation to the new collapsible fenced formatting. |
| .changeset/slimy-owls-matter.md | Adds a patch changeset entry documenting the renderer behavior change. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
engine/cld/mcms/proposalanalysis/renderer/templates/markdown/parameter.tmpl
Show resolved
Hide resolved
Always render parameter values in fenced ```text``` blocks wrapped in <details open> so tuple arrays and long values match simple arrays, and readers can collapse values when skimming. Remove the newline-based inline vs fenced branch and the unused hasNewline template helper.
graham-chainlink
force-pushed
the
ggoh/mcms-proposal-parameter-markdown
branch
from
dfb5066 to
091d1d0
Compare
|
| - **`chainsToAdd`** (`tuple[]`): (decoded) | ||
| - **`remoteChainSelectorsToRemove`** (`uint64[]`): | ||
| <details open> | ||
| <summary>Value</summary> |
There was a problem hiding this comment.
| <summary>Value</summary> |
Maybe we could remove these value summary? I think it is repetitive and and users will know it is a value because the code block.
Summary
Proposal analysis markdown renderer rendered some parameters inline and others in fenced
```text```blocks depending on whether the formatted value contained a newline which is probably not a good signal. That made tuple, arrays and other structured values harder to read as they are not rendered in text blockeg below note
capabilityConfigurationsChanges
After
