feat: improve TypeDoc HTML migration lane#698
Conversation
Vercel PreviewPreview URL: https://docs-portal-ouv3emfbe-agora-devx.vercel.app |
|
Issue #785 已修复(633ce9632):真实 Flexible Classroom Web TypeDoc 导出现在普通重跑即自动使用 bundled 11-Store public navigation;显式 generated 仍优先。精确源/基线复现通过,迁移测试 20/20,Standards/Spec PASS,待复测。 |
|
#799 已在本 PR 原分支修复( |
|
同步 #803:已将 DocsShell 单次正文挂载根修复与 TypeDoc H1/hash 唯一性回归同步到本原 PR(9ba5de39a、c215dbfb3、80f534262)。不删生成内容标题;专项/迁移/类型/双轴审查通过,待文档团队复测。 |
|
#804 已复核并固化回归:cea4008ee。\n\n在 d172 基线用当前脚本迁移真实 Flexible Classroom Web 源后,公开侧栏仅含 11 个 Store 条目;Meeting / Private Room 条目不在该页链接 DOM。新增测试覆盖 product → web → api-reference 的祖先注册、navScope 保留及重复运行幂等。\n\n验证:migration 25/25、types:check、Biome、diff check、真实源迁移和浏览器可见侧栏均通过。请文档团队基于最新 head 复测。 |
Summary
Closes #692.
Closes #693.
Fixes #715.
Fixes #716.
Details
node scripts/html-to-md-migration.mjsas the entrypoint..tsd-page-title h1wins over document<title>.Class AgoraRteEngineConfigtoAgoraRteEngineConfig.classes/agora-rte-engine-config.mdx.Optionalwhile preserving signature optionality.Verification
bun run test scripts/html-to-md-migration.test.ts(10 passed)node --check scripts/html-to-md-migration.mjsbunx biome check scripts/html-to-md-migration.mjs scripts/html-to-md-migration.test.tsbun run types:checkshengwang-doc-source/html-docs/whiteboard/WebMemberStateandPlayableCheckingParamsproperty documentation restoredJoinRoomParams.hotKeystable remains structured and orderedOptionalbadges do not leak into property headingsshengwang-doc-source/html-docs/flexible-classroom/Webshengwang-doc-source/html-docs/rtc/Android --dry-runbun run buildwas not run.