Whiteboard SDK API pages lack scoped navigation and render flattened index content

[Foesa-yyx]

This was generated by AI during triage.

Related Migration PRs

• feat: improve TypeDoc HTML migration lane #698: feat: improve TypeDoc HTML migration lane #698
• feat: improve Doxygen HTML migration lane #699: feat: improve Doxygen HTML migration lane #699
• feat: improve iOS HTML migration lane #701: feat: improve iOS HTML migration lane #701

Problem

In the migrated Chinese API Reference, the Whiteboard SDK entries under 互动白板 do not expose usable scoped API navigation for the SDK pages:

• Android SDK — /zh-CN/api-reference/whiteboard/android
• iOS SDK — /zh-CN/api-reference/whiteboard/ios
• Web SDK — /zh-CN/api-reference/whiteboard/web

The left sidebar only shows the top-level 互动白板 entries (Fastboard Android, Fastboard iOS, Fastboard Web, Android SDK, iOS SDK, Web SDK, RESTful API). It does not show the nested API reference navigation for the selected SDK, so users cannot browse into classes, protocols, constants, interfaces, enums, etc. from the sidebar.

The SDK landing pages also render poorly. The iOS SDK page is the clearest example: source navigation groups are flattened into one long paragraph of inline links, and generator footer text is visible at the bottom.

Evidence

These pages are part of the #712 HTML API migration output:

• content/docs/zh-CN/api-reference/whiteboard/android/index.mdx
• content/docs/zh-CN/api-reference/whiteboard/ios/index.mdx
• content/docs/zh-CN/api-reference/whiteboard/web/index.mdx

Each SDK folder has a generated meta.json, for example:

• content/docs/zh-CN/api-reference/whiteboard/android/meta.json
• content/docs/zh-CN/api-reference/whiteboard/ios/meta.json
• content/docs/zh-CN/api-reference/whiteboard/web/meta.json

But the top-level API Reference navigation links to these SDK roots from content/docs/zh-CN/api-reference/meta.json without exposing the nested SDK nav in the rendered sidebar.

Current top-level entries:

"[Android SDK](/zh-CN/api-reference/whiteboard/android)",
"[iOS SDK](/zh-CN/api-reference/whiteboard/ios)",
"[Web SDK](/zh-CN/api-reference/whiteboard/web)"

The iOS landing page also includes flattened appledoc navigation and footer content as regular page body:

Programming Guides [Agora Interactive Whiteboard Objective-C Overview](...) Class References [WhiteAppParam](...) ...

Copyright © 2025 Agora. All rights reserved. Updated: 2025-04-07 Generated by [appledoc 2.2.1 (build 1334)](...).

Impact

Users who click Android SDK, iOS SDK, or Web SDK cannot browse the migrated SDK API reference through the sidebar. They either land on a single page with many inline links or must rely on in-page links/search instead of structured API navigation.

For iOS, the page also looks visibly broken because appledoc navigation is flattened into prose and appledoc generator footer text is exposed as content.

Scope Notes

This is not the RESTful API entry. RESTful API belongs to the OpenAPI migration path and is out of scope here.

This is related to the HTML migration lanes but is not fully covered by the broad implementation issues:

• Implement Doxygen and Javadoc HTML API migration lane #694 covers the Doxygen/Javadoc lane generally; Whiteboard Android is one affected output.
• Implement iOS doc-generator and appledoc HTML API migration lane #695 covers the iOS doc-generator/appledoc lane generally; Whiteboard iOS is one affected output.
• TypeDoc API migration drops global type member documentation #715/TypeDoc API migration flattens tables in member documentation #716 cover Whiteboard Web TypeDoc content loss/table issues, not missing scoped navigation.

This issue tracks the user-facing Whiteboard SDK navigation/rendering problem in the migrated #712 output.