Skip to content

feat: improve iOS HTML migration lane#701

Open
shczhen wants to merge 10 commits into
codex/html-migration-doxygenfrom
codex/html-migration-ios
Open

feat: improve iOS HTML migration lane#701
shczhen wants to merge 10 commits into
codex/html-migration-doxygenfrom
codex/html-migration-ios

Conversation

@shczhen

@shczhen shczhen commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Enables the iOS doc-generator/Jazzy/appledoc lane semantic renderer.
  • Converts appledoc class/protocol methods, parameters, returns, discussion, availability, constants, blocks, and overview/docs pages into Fumadocs-safe Markdown.
  • Preserves stable anchors and rewrites internal .html links against the generated route tree.
  • Keeps hierarchy.html alone from causing Doxygen/Javadoc trees to be misdetected as iOS output.

Closes #695.

Stack

Stacked on #698 (codex/html-migration-typedoc). Base branch: codex/html-migration-typedoc.

Verification

  • node --check scripts/html-to-md-migration.mjs
  • bun run test scripts/html-to-md-migration.test.ts
  • bun x biome check scripts/html-to-md-migration.mjs scripts/html-to-md-migration.test.ts scripts/html-migration
  • bun run types:check
  • Real iOS dry-run:
    • node scripts/html-to-md-migration.mjs --source /Users/czhen/Documents/GitHub/AgoraIO/shengwang-doc-source/html-docs/whiteboard/iOS --output /tmp/check-ios-whiteboard-dry --product whiteboard --platform ios --route-base-path /zh-CN/api-reference --dry-run
    • Detected iOS-doc-generator HTML reference, 61 input files, 75 planned output files.
  • Real iOS full migration:
    • node scripts/html-to-md-migration.mjs --source /Users/czhen/Documents/GitHub/AgoraIO/shengwang-doc-source/html-docs/whiteboard/iOS --output /tmp/check-ios-whiteboard-full --product whiteboard --platform ios --route-base-path /zh-CN/api-reference
    • Produced 75 files including classes, protocols, docs/headers, constants, blocks, and nested meta.json.
  • DITA non-regression dry-run:
    • node scripts/html-to-md-migration.mjs --source /Users/czhen/Documents/GitHub/AgoraIO/shengwang-doc-source/html-docs/rtc/Android --output /tmp/check-dita-rtc-android --product rtc --platform android --route-base-path /zh-CN/api-reference --dry-run
    • Detected DITA-OT/Oxygen API reference (API/ directory).

Notes

bun run test was also run. It currently fails in unrelated baseline suites outside this migration script:

  • src/lib/legacy-sitemap/legacy-sitemap-audit.test.ts
  • src/lib/docs-content-regressions.test.ts
  • src/components/docs-shell/DocsShell.test.tsx

@shczhen
shczhen force-pushed the codex/html-migration-ios branch from 6dab831 to 70fc6b3 Compare July 9, 2026 09:15
@shczhen
shczhen changed the base branch from codex/html-migration-typedoc to codex/html-migration-doxygen July 9, 2026 09:15
@shczhen
shczhen force-pushed the codex/html-migration-ios branch from 70fc6b3 to e484a4b Compare July 9, 2026 09:24
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

Vercel Preview

Preview URL: https://docs-portal-cwkdjbkco-agora-devx.vercel.app

@shczhen

shczhen commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator Author

Issue #761 已修复:中文 Whiteboard iOS 根标题与四类 appledoc 索引标题已本地化,规则限定 zh-CN + whiteboard + ios,并有非 iOS 负向覆盖。迁移测试 15/15 通过;生成内容已同步到 PR #712,等待 doc team Preview 验证。

@shczhen

shczhen commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator Author

对应 #772 的根因修复已推送:f58a5e366。新增 cheerio 根级直接开发依赖;干净 frozen install、真实 iOS dry-run(61 个文件)及迁移测试 15/15 均通过。请 doc team 继续测试,PR 不合并。

@shczhen

shczhen commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator Author

已将本 stacked PR 重放到当前 #699 head,消除父分支冲突;当前 head a0b1c6658,merge state CLEAN。验证:27/27 迁移测试、类型检查、Biome、真实 iOS 61-file dry-run 通过。未合并,继续供 doc team 测试。

@shczhen

shczhen commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator Author

#778 已修复于 e4881767d:iOS lane 不再为没有源 index 的 Classes/Protocols 目录生成可点击 placeholder wrapper,真实成员导航保留;行为严格限制在 iOS generator。迁移测试 28/28、types/biome/node/diff 检查通过,待 doc team 测试,PR 未合并。

@shczhen

shczhen commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator Author

#791 复核:当前本 PR 对 Whiteboard iOS 同源重跑 62 个 MDX,正文 H1=0。重复 DOM H1 来自旧 baseline DocsShell 双挂载,根修复在汇总 PR #712;未做内容层 workaround。待基于 #712 完整 head 复测。

@shczhen

shczhen commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator Author

#799 已在本 PR 原分支修复(cfa6d902c):iOS 方法、常量、block declaration 统一显示 Objective-C 标题,并包含前序 lane 的同一根因修复。迁移测试 28/28、types、Biome 通过,待文档团队复测。

@shczhen

shczhen commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator Author

#807 已修复:17ef3be9a 从 DocsShell 根层消除响应式双正文挂载,4c0c801e2 增加 WhiteSDK iOS H1 唯一性回归。未修改迁移器或生成内容。

验证:专项 2/2、migration 28/28、DocsContent 48/48、types、Biome、diff check、双轴审查均通过。请从本 PR 最新 head 复测。

@shczhen

shczhen commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator Author

Issue #808 已在本 PR 修复:ed4a4a03e。根因是 iOS lane 未登记 Whiteboard 产品级与 API Reference 根级祖先导航;现在迁移器幂等补齐两级 page-tree 挂载。最新基线真实源重跑及页面树局部侧栏验证通过,迁移测试 29/29,待文档团队复测。

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