Repository navigation
Proposal: legal-document diff example for the basic catalog — is Markdown-in-Text the right approach? #2620
agarwaldipali-hash
started this conversation in
Ideas
Replies: 1 comment
|
Implementation is up as #2554 — I've updated that PR's description to point back here so the design question and the code stay in sync. |
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
What I built
I put together a spec example (
37_legal-document-diff.json) for thebasiccatalog that models an enterprise agent comparing two versions of a software licensing agreement — a "legal redline" view. It's opened as PR #2554.The surface renders a
Card→Columncontaining a diff summary, three modified contract sections (license grant, telemetry/data handling, liability cap), and an actionRowwith acknowledge/export buttons that emit anacknowledge_diffevent.Why I think it's interesting
Document review is a common enterprise agent task, and the existing basic-catalog examples don't cover "agent presents a structured comparison and asks the user to accept it". The event payload carries
sourceVersion/targetVersion, so the acknowledge action is meaningful rather than decorative.The part I'd like input on
To show the redline, I leaned on Markdown inside
Text— specifically fenced```diffblocks. I noticed afterwards that the catalog documentsText.textas supporting simple Markdown and says "utilizing dedicated UI components is generally preferred". So I'd rather ask than assume:Textconsidered in-scope for "simple Markdown", or is that stretching the component past its intent?diff) something renderers are expected to handle consistently, or is it renderer-dependent in practice?Textis the wrong vehicle, is a diff/comparison presentation something the basic catalog would want as a dedicated component — or is this simply out of scope?Happy to rework the example, scope it down, or drop it entirely depending on what makes sense. I mainly want to know whether this direction is useful before asking anyone to spend review time on it.
— PR: #2554
All reactions