Skip to content

docs: align Node support guidance with core policy - #162

Draft
elonehoo wants to merge 2 commits into
mainfrom
docs/align-core-node-policy
Draft

elonehoo wants to merge 2 commits into
mainfrom
docs/align-core-node-policy

Conversation

@elonehoo

@elonehoo elonehoo commented Oct 22, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Replace the outdated separate core Node 20 contract with the policy merged in feat!: require Node 22.22.3 for public core packages destyler#360.
  • Record that restoring Node 20 support is not planned for UI or core.
  • Distinguish repository main from future releases containing the policy changes; already published UI and core artifacts remain unchanged.

Related: #153 (policy wording updated; issue remains open).

Scope

Documentation only: no UI engine, dependency, runtime, version, tag, or npm publication changes.

Validation

  • git diff --check: passed.
  • node --test scripts/test-publish.mjs: 383/383 passed.
  • Independent documentation review: no blocking findings.
  • Remote commit/tree and document read back and verified.
  • Full PR CI and both Vercel previews passed on 668be618 (Node 22.22.3/24 source suites, four packed consumers, accessibility smoke and lint).
  • Node 24's first attempt stalled on Ubuntu apt dependency downloads; after confirming cancellation, one job-only rerun passed without code or gate changes.
  • Follow-up on e10e6db: split policy into UI/core/published-artifact bullets, link core's canonical support guide, and remove PR-only wording. The future-release qualifier remains explicit.
  • Local publish checks rerun: 383/383 passed; full CI pending on the new head. Draft until validation completes. No merge, npm publication, or tag creation.

View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.


Note

Cursor Bugbot is generating a summary for commit 668be61. Configure here.

@vercel

vercel Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
destyler-ui Ready Ready Preview Oct 22, 2026 2:00pm UTC
destyler-ui-dev Ready Ready Preview Oct 22, 2026 2:00pm UTC

@elonehoo
elonehoo marked this pull request as ready for review October 22, 2026 13:25
@elonehoo

Copy link
Copy Markdown
Member Author

🤖 Review(中文)

基于提交:668be61

概要:本 PR 仅修改 docs/node-support.md(+8 / -3),删除了“core 仍保持 Node 20 消费者契约”的过时说明,改为与已合并的 destyler/destyler#360 保持一致:UI 与 core 均不计划恢复 Node 20 支持,且该要求只作用于后续发布版本,不影响已发布的产物。改动与描述一致,范围确实只限文档。

我核对了几点:

  • feat!: require Node 22.22.3 for public core packages destyler#360 已于 2026-10-22 合并;core main 上的公开包(如 packages/anatomy、packages/components/*)均声明 engines.node: ">=22.22.3",与文中表述一致。
  • UI 根 package.json 同为 >=22.22.3,与文档开头一致。
  • 文档末尾 “Node 20 compatibility is no longer a UI release requirement” 与新段落不冲突。

建议(均为非阻塞的小问题):

  1. docs/node-support.md 第 9–16 行:这一段同时讲了 UI、core、已发布产物和“本次文档不改包”四件事,信息密度较高。建议拆成 2–3 个短要点(UI 发布 / core 发布 / 已发布产物不变),更易扫读。
  2. “Core's main branch also requires…” 属于会随时间过期的描述。建议改为以 #360 为锚点的表述(例如 “Since feat!: require Node 22.22.3 for public core packages destyler#360, public @destyler/* packages require…”),或链接到 core 仓库中的 Node 支持文档,避免日后 main 变化时这里再次过时。
  3. 可选:core 仓库根 package.json(开发环境)使用的是更窄的 ^22.22.3 || ^24.16.0 || >=26.3.0,与公开包的 >=22.22.3 不同。文中明确写的是“public @destyler/* packages”,所以没错;但如果读者会同时在两个仓库开发,可以加半句说明,避免混淆。
  4. 最后一句 “This documentation update changes no package engines…” 描述的是 PR 本身而非文档长期内容,合并后读起来会有点奇怪,建议删掉或放到 PR 描述里即可。

结论:文档准确、与 core 政策一致,可以合并;以上建议可酌情采纳。

@elonehoo

Copy link
Copy Markdown
Member Author

🤖 Review (English)

Based on commit: 668be61

Summary: This PR only touches docs/node-support.md (+8 / -3). It removes the outdated statement that core keeps a separate Node 20 consumer contract and aligns the doc with the merged destyler/destyler#360: restoring Node 20 support is not planned for UI or core, and the requirement applies only to future releases, not already-published artifacts. The change matches the description and is genuinely docs-only.

What I verified:

  • feat!: require Node 22.22.3 for public core packages destyler#360 was merged on 2026-10-22, and public packages on core main (e.g. packages/anatomy, packages/components/*) declare engines.node: ">=22.22.3", matching the new text.
  • The UI root package.json also declares >=22.22.3, consistent with the top of the doc.
  • The closing line "Node 20 compatibility is no longer a UI release requirement" doesn't conflict with the new paragraph.

Suggestions (all minor, non-blocking):

  1. docs/node-support.md lines 9–16: this paragraph covers four things at once (UI release, core release, published artifacts, and "this doc update changes nothing"). Consider splitting it into 2–3 short bullets (UI release / core release / published artifacts unchanged) so it's easier to scan.
  2. "Core's main branch also requires…" will go stale over time. Consider anchoring it to the PR instead (e.g. "Since feat!: require Node 22.22.3 for public core packages destyler#360, public @destyler/* packages require…") or linking to core's own Node support doc, so this doesn't drift again when main moves.
  3. Optional: core's root package.json (development) uses a narrower range, ^22.22.3 || ^24.16.0 || >=26.3.0, than the public packages' >=22.22.3. The doc explicitly says "public @destyler/* packages", so it's correct, but a half-sentence note could help contributors who work in both repos.
  4. The last sentence, "This documentation update changes no package engines…", describes the PR rather than the lasting content of the doc and will read oddly after merge. Consider dropping it (the PR description already covers it).

Verdict: Accurate and consistent with the core policy; fine to merge. Take the suggestions as you see fit.

@elonehoo

Copy link
Copy Markdown
Member Author

🤖 レビュー(日本語)

対象コミット:668be61

概要:本 PR は docs/node-support.md のみを変更しています(+8 / -3)。「core は別途 Node 20 の利用者向け契約を維持する」という古い記述を削除し、マージ済みの destyler/destyler#360 に合わせて、UI・core ともに Node 20 サポートを復活させる予定はないこと、そしてこの要件は今後のリリースにのみ適用され、公開済みの成果物には影響しないことを明記しています。変更内容は説明と一致しており、ドキュメントのみの変更です。

確認した点:

  • feat!: require Node 22.22.3 for public core packages destyler#360 は 2026-10-22 にマージ済みで、core main の公開パッケージ(例:packages/anatomy、packages/components/*)はいずれも engines.node: ">=22.22.3" を宣言しており、本文の記述と一致します。
  • UI のルート package.json も >=22.22.3 で、ドキュメント冒頭と整合しています。
  • 末尾の「Node 20 compatibility is no longer a UI release requirement」とも矛盾しません。

提案(いずれも軽微で、ブロッカーではありません):

  1. docs/node-support.md 9〜16 行目:この段落は UI リリース、core リリース、公開済み成果物、「今回のドキュメント更新は何も変えない」の 4 点を一度に述べていて情報量が多めです。2〜3 個の短い箇条書き(UI リリース / core リリース / 公開済み成果物は不変)に分けると読みやすくなります。
  2. 「Core's main branch also requires…」は時間が経つと古くなる表現です。PR を基準にした表現(例:「Since feat!: require Node 22.22.3 for public core packages destyler#360, public @destyler/* packages require…」)にするか、core リポジトリ側の Node サポート文書へリンクすると、main が変わったときに再びずれるのを防げます。
  3. 任意:core のルート package.json(開発環境)は公開パッケージの >=22.22.3 より狭い ^22.22.3 || ^24.16.0 || >=26.3.0 を使っています。本文は「public @destyler/* packages」と明記しているので誤りではありませんが、両リポジトリで開発する人向けに一言補足すると混乱を避けられます。
  4. 最後の一文「This documentation update changes no package engines…」はドキュメントの恒久的な内容ではなく PR 自体の説明なので、マージ後に読むと少し不自然です。削除を検討してください(PR 説明に既に書かれています)。

結論:内容は正確で core のポリシーとも一致しており、マージして問題ありません。提案は必要に応じて取り入れてください。

@elonehoo
elonehoo marked this pull request as draft October 22, 2026 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant