docs(adr): ADR-0051 — inline metadata views in docs (metadata fenced block)#1940
Merged
Conversation
…block) Concretizes the "inline metadata views" ADR-0046 §3.5/§6.7 already reserved but left without a syntax. A ```metadata fenced block compiles to a new read-only `element:metadata_viewer` SDUI component, resolved live and permission-projected at read time. Key decisions: - Fenced code block (already-legal CommonMark per §3.4) over directives/MDX — does not reopen the trust boundary. - Body is a declarative reference (data, not code), so it stays on the data side of the ADR-0025/§3.4 boundary that banned MDX. - Compiles 1:1 to one ObjectUI component — one runtime, one schema, one permission path; no parallel renderer. - Kernel unchanged: doc.content stays inert (§3.1); resolution is render-time only. - Scope metadata-only, phased state_machine -> flow -> permission; `object` and a general `objectui` fence deferred. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
size/m
documentation
This was referenced Jun 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds ADR-0051, specifying how an author embeds a live, read-only metadata view inside a
doc— the```metadatafenced block.This concretizes a concept ADR-0046 already reserved but never gave a syntax:
Key decisions
```metadatafenced block whose body is a declarative reference (type/name/object/mode/detail). Chosen over directives/MDX because a fenced block is already-legal CommonMark per §3.4 — it does not reopen the MDX/directive ban.objectuibody could carry CEL/actions = code → deferred.)element:metadata_viewerSDUI component (ComponentPropsMap,embeddableInDoc). One component model, one schema, one permission path — no parallel renderer.detail(altitude) vs automatic, render-time permission projection.doc.contentstays inert (§3.1); resolution is render-time only. Inherits §6.7 anonymous degradation verbatim.state_machine→flow→permission;objectand a general```objectuifence explicitly deferred.Scope of this PR
Documentation only — one new file under
docs/adr/. No code/spec changes; theMetadataEmbedSchemaandelement:metadata_viewershapes shown are illustrative and settle in a follow-up spec PR (P1).🤖 Generated with Claude Code