You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 28f8993
Browse filesBrowse the repository at this point in the historyBrowse files
fix(spec): api, doc and book descriptions say only what the code does
api names the two endpoint types that execute (flow, object operation); doc
and book drop the package-only clause, since both are runtime-creatable.
Claude-Session: https://claude.ai/code/session_014SHyy7c7ipsMkzJ3J9mdL9
Co-authored-by: Claude <noreply@anthropic.com>
en: 'A stable HTTP URL that other systems call to reach flows, scripts and data in the app',
315
+
en: 'A stable HTTP URL that other systems call to run a flow or work with records in the app',
316
316
verdict: ALL_TRANSLATE,
317
317
reason:
318
-
'REWRITTEN AS PLAIN ADMIN COPY: the registry description is what Setup shows, so it says what the item is and who uses it, and the ADR-0121 vocabulary (declarative endpoint, policy layer, pipeline) moved to the comment beside the registry row. "flows, scripts and data" names what ApiEndpointSchema.type can target (flow/script/object_operation; proxyis the rare fourth) in words an admin reads. ⇒ 其他系统调用的稳定 HTTP URL,用于访问应用的流程、脚本和数据 / 他のシステムがアプリのフロー、スクリプト、データにアクセスするために呼び出す固定の HTTP URL / URL HTTP estable a la que llaman otros sistemas para acceder a los flujos, scripts y datos de la aplicación. ⭐ `HTTP` and `URL` stay machine tokens in all three, asserted by the token guard below. ⚠️ No second person in zh/ja/es: the catalog carries no 你的/您的, so "the app" is rendered 应用 / アプリ / la aplicación.',
318
+
'REWRITTEN AS PLAIN ADMIN COPY: the registry description is what Setup shows, so it says what the item is and who uses it, and the ADR-0121 vocabulary (declarative endpoint, policy layer, pipeline) moved to the comment beside the registry row. It names only what EXECUTES: ApiEndpointSchema.type says only `flow` and `object_operation` run, while `script` and `proxy` are rejected at publish, so "run a flow or work with records" is the whole servable set in an admin\'s words. "records" takes the catalog\'s record noun (记录 / レコード / registros). ⇒ 其他系统调用的稳定 HTTP URL,用于运行流程或操作应用中的记录 / 他のシステムが呼び出す固定の HTTP URL。フローを実行したり、アプリのレコードを操作したりします / URL HTTP estable a la que llaman otros sistemas para ejecutar un flujo o trabajar con los registros de la aplicación. ⭐ `HTTP` and `URL` stay machine tokens in all three, asserted by the token guard below. ⚠️ No second person in zh/ja/es: the catalog carries no 你的/您的.',
en: 'A help page written in Markdown that a package ships for its users to read',
333
+
en: 'A help page written in Markdown that a package ships or you write yourself',
334
334
verdict: ALL_TRANSLATE,
335
335
reason:
336
-
'REWRITTEN AS PLAIN ADMIN COPY: "flat Markdown items (ADR-0046)" became what an admin meets, a help page, and the ADR reference moved to the comment beside the registry row. `package` is still rendered as the noun, by the near-miss clearing asserted below (zh prose takes 软件包, as in 软件包层). ⇒ 软件包随附的 Markdown 帮助页面,供用户阅读 / パッケージに同梱される、ユーザー向けの Markdown ヘルプページ / Página de ayuda en Markdown que un paquete incluye para que la lean sus usuarios. ⭐ `Markdown` is KEPT as a format proper noun in all three; asserted by the token guard.',
336
+
'REWRITTEN AS PLAIN ADMIN COPY: "flat Markdown items (ADR-0046)" became what an admin meets, a help page, and the ADR reference moved to the comment beside the registry row. Both origins are named because the registry row is `allowRuntimeCreate: true`: a doc can be shipped by a package or drafted in place through saveMetaItem. `package` is still rendered as the noun, by the near-miss clearing asserted below (zh prose takes 软件包). zh/ja/es carry the second origin impersonally (自行编写 / 自分で作成 / redactada directamente). ⇒ 以 Markdown 编写的帮助页面,可由软件包随附,也可自行编写 / Markdown で書かれたヘルプページ。パッケージに同梱されるほか、自分で作成することもできます / Página de ayuda en Markdown, incluida en un paquete o redactada directamente. ⭐ `Markdown` is KEPT as a format proper noun in all three; asserted by the token guard.',
en: 'A table of contents that groups the help pages of a package into ordered sections',
351
+
en: 'A table of contents that groups help pages into ordered sections',
352
352
verdict: ALL_TRANSLATE,
353
353
reason:
354
-
'REWRITTEN AS PLAIN ADMIN COPY: "navigation spine — ordered groups with derived membership (ADR-0046 §6)" became a table of contents, and the ADR-0046 §6 vocabulary moved to the comment beside the registry row. "help pages" is the same phrase the doc row now uses, so the two types read as a pair in every locale. "sections" is prose, not BookSchema.groups (a key that takes an array, asserted below). ⇒ 将软件包的帮助页面按顺序分节组织的目录 / パッケージのヘルプページを順序付きのセクションにまとめた目次 / Índice que organiza las páginas de ayuda de un paquete en secciones ordenadas. No machine token is kept: the ADR citation and its §6 are exactly what this rewrite removed, asserted by the plain-copy guard below.',
354
+
'REWRITTEN AS PLAIN ADMIN COPY: "navigation spine — ordered groups with derived membership (ADR-0046 §6)" became a table of contents, and the ADR-0046 §6 vocabulary moved to the comment beside the registry row. No package clause: the row is `allowRuntimeCreate: true` and a brand-new book can be authored in place. "help pages" is the doc row\'s own phrase, so the two types read as a pair in every locale. "sections" is prose, not BookSchema.groups (a key that takes an array, asserted below). ⇒ 将帮助页面按顺序分节组织的目录 / ヘルプページを順序付きのセクションにまとめた目次 / Índice que organiza las páginas de ayuda en secciones ordenadas. No machine token is kept: the ADR citation and its §6 are exactly what this rewrite removed, asserted by the plain-copy guard below.',
// metadata-forms translations), so it stays in plain words; the design it
1134
1134
// summarises — a declarative endpoint, a stable URL and policy layer over an
1135
1135
// existing pipeline — is ADR-0121.
1136
-
{type: 'api',label: 'API Endpoint',description: 'A stable HTTP URL that other systems call to reach flows, scripts and data in the app',filePatterns: ['**/*.api.ts','**/*.api.yml','**/*.api.json'],supportsOverlay: false,allowEnvironmentOverlay: false,allowRuntimeCreate: false,supportsVersioning: false,executionPinned: false,loadOrder: 92,domain: 'system'},
1136
+
{type: 'api',label: 'API Endpoint',description: 'A stable HTTP URL that other systems call to run a flow or work with records in the app',filePatterns: ['**/*.api.ts','**/*.api.yml','**/*.api.json'],supportsOverlay: false,allowEnvironmentOverlay: false,allowRuntimeCreate: false,supportsVersioning: false,executionPinned: false,loadOrder: 92,domain: 'system'},
// never parses `content`. loadOrder is last: nothing references docs.
1144
1144
// `description` is admin-facing copy: plain words, the ADR-0046 vocabulary
1145
1145
// (flat Markdown items) stays in this comment.
1146
-
{type: 'doc',label: 'Documentation',description: 'A help page written in Markdown that a package ships for its users to read',filePatterns: ['**/docs/*.md'],supportsOverlay: false,allowEnvironmentOverlay: false,allowRuntimeCreate: true,supportsVersioning: false,executionPinned: false,loadOrder: 99,domain: 'system'},
1146
+
{type: 'doc',label: 'Documentation',description: 'A help page written in Markdown that a package ships or you write yourself',filePatterns: ['**/docs/*.md'],supportsOverlay: false,allowEnvironmentOverlay: false,allowRuntimeCreate: true,supportsVersioning: false,executionPinned: false,loadOrder: 99,domain: 'system'},
{type: 'book',label: 'Documentation Book',description: 'A table of contents that groups the help pages of a package into ordered sections',filePatterns: ['**/*.book.ts'],supportsOverlay: true,allowEnvironmentOverlay: false,allowRuntimeCreate: true,supportsVersioning: false,executionPinned: false,loadOrder: 99,domain: 'system'},
1163
+
{type: 'book',label: 'Documentation Book',description: 'A table of contents that groups help pages into ordered sections',filePatterns: ['**/*.book.ts'],supportsOverlay: true,allowEnvironmentOverlay: false,allowRuntimeCreate: true,supportsVersioning: false,executionPinned: false,loadOrder: 99,domain: 'system'},
0 commit comments