Skip to content

docs: TypeScript examples in PUBLISHED package READMEs that do not compile — split the #18751 census into published-README vs internal-document blocks and correct the wrong examples in published READMEs only (#18715 ruling F) #18915

Description

@hotlong

Filed by the director seat (objectstack #12708, summon #24, session_01Wj1HUjzyeiBQ8atRf1ZhaL) executing decision batch #156 item 2 — maintainer 「同意」 to F on #18715: ⛔ no gate is built; the user-facing half of the census is worked here.

The reading (PR #18751's census instrument, on main; re-run before acting)

1,002 TypeScript fenced blocks in package-root Markdown. Hand-written documents: 54 files / 282 blocks — 195 fail to compile; 76 under the tolerant reading (legal elisions allowed); 58 syntactically valid and wrong (copy-paste fails). CHANGELOGs (720 blocks) are out of scope: they correctly record deleted APIs.

Ask

  1. Split the 76 / 58 by publication: a block is published when its document is inside its package's files[] (README.md and siblings that ship); everything else (PHASE2_IMPLEMENTATION.md, design notes, internal guides) is internal. Record both counts on this card with the instrument's output.
  2. Correct the published-README examples that are syntactically valid and wrong, one PR per package or one PR overall — the claimant's call — so that every example a platform user's AI can copy compiles against the package it documents. A block that documents a removed API is rewritten or deleted, ⛔ never left as a fossil.
  3. ⛔ Internal-document blocks are not worked here. If an internal document is dead, deleting it is the fix, on its own card.
  4. ⛔ No gate, no ratchet, no CI wiring (ruling F). Clause-②: no; changeset skip-changeset (docs only) unless a package ships its README changes in a release note by convention.

Refs

#18715 (ruling F) · PR #18751 (the census instrument) · #15931 · #18620 / PR #18712

Dedup terms: published README examples compile, fenced TypeScript block typecheck, files[] published document split


Blocked-by: #18973

⚠️domain:devx 执行席在 PR #18968(Part of)落地后补上,⛔ 纯增量。本卡 44 个已发布错块修了 43;剩下的 1 块(packages/plugins/knowledge-ragflow/README.md)卡在 #18973 的裁决上 —— 那里在问 source.optionsadapterConfig 哪个是契约,两种收法都是运行时改动,⛔ 不是文档卡能自答的。

⚠️ 释放机制是人工,⛔ 不会自动触发(H26 的形状):#18973 现读 needs-user-decision,而被回答⛔ 不产生关闭事件,所以纯 Blocked-by: 在这里是一个永不自动解锁的块。


Generated by Claude Code

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions