docs(adr): ADR-0049 — semantic-reference metadata embeds in package docs#1794
Closed
xuyushun441-sys wants to merge 2 commits into
Closed
docs(adr): ADR-0049 — semantic-reference metadata embeds in package docs#1794xuyushun441-sys wants to merge 2 commits into
xuyushun441-sys wants to merge 2 commits into
Conversation
Specifies how a doc author shows a live flow/view/dashboard/object inside package documentation without re-opening the MDX trust boundary banned by ADR-0046 §3.4 / ADR-0025. Core inversion: the author supplies only a NAME (data); the platform supplies the COMPONENT (code). Extends ADR-0046 §3.4's protocol-link family (flow://, view://, dashboard://, object://) — each resolves renderer-side to a read-only, permission-scoped SchemaRenderer scoped to one metadata item, accepting no author-supplied props. Two guardrails: (a) read-only + permission-scoped against the current viewer; (b) cross-package refs degrade to a render-time "not found" notice, never coupling into install-time dependency resolution. Boundary stated on one line: in-metadata → live embed (this ADR); conceptual → Mermaid (deferred); author-written component code → never. Rejects inline SDUI JSON, MDX, and author-supplied iframes. P3+ — depends on the §3.4 resolution layer and read-only embeddable metadata-view components in objectui, neither built. Status: Proposed. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
xuyushun441-sys
added
documentation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
6 tasks
Contributor
Author
|
Tracking issue: #1795 |
0048 was already claimed by the cross-package-metadata-collision ADR (branch feat/cross-package-metadata-collision, PR #1796), which predates this one. Renumber to the next free slot to resolve the collision. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
xuyushun441-sys
changed the title
Contributor
Author
|
作废。经讨论,文档里的活 UI 应归产品 UI 层(View/Page/Dashboard 的 SchemaRenderer + SDUI 组件库),文档不应成为第二个 UI 授作面。本 ADR 不推进,关闭不合并。 |
os-zhuang
added a commit
that referenced
this pull request
Jun 18, 2026
feat: iOS desktop home (bento) + tier-B polish (#1794) objectui@be7c6e9de6363f1001e3749f48c063dece969973
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
2 participants
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.
Summary
Adds ADR-0048: Semantic-reference metadata embeds in package documentation (Status: Proposed).
ADR-0046 made package docs flat
src/docs/*.mdMarkdown and banned MDX (MDX is code; rendering publisher code in the platform origin crosses the ADR-0025 trust boundary), while §3.4 reserved semantic links likeobject://crm_lead"renderers resolve" and §3.5 said a diagram of an existing flow is derived metadata — rendered live, never committed. This ADR specifies what walks through that door: how an author shows a live flow/view/dashboard/object in a doc without re-opening the MDX boundary.Core inversion: the author supplies only a NAME (data); the platform supplies the COMPONENT (code) — the opposite of author-written MDX/SDUI, which must stay banned (SDUI is worse than MDX: its nodes bind actions/data/server-calls).
flow://,view://,dashboard://,object://. Markdown-native (a link) → GitHub/editor preview degrades to an inert link, lint stays a parse-only check. Resolves renderer-side to a read-onlySchemaRendererscoped to one item, no author-supplied props.Alternatives explicitly rejected: inline SDUI component JSON, MDX/author React, author-supplied
<iframe>, custom fenced blocks, publish-time baking, and lint-time metadata resolution.File
docs/adr/0048-semantic-metadata-embeds-in-docs.mdTracking issue: see linked issue.
Review only — do not merge.
🤖 Generated with Claude Code