Skip to content

docs: restore source guidance lost in API regeneration - #4029

Merged
Foesa-yyx merged 1 commit into
masterfrom
codex/restore-api-feedback-regressions
Oct 30, 2026
Merged

Foesa-yyx merged 1 commit into
masterfrom
codex/restore-api-feedback-regressions

Conversation

@Foesa-yyx

@Foesa-yyx Foesa-yyx commented Oct 30, 2026 •

Copy link
Copy Markdown
Collaborator

Restore previously reviewed documentation fixes that were overwritten by later API regeneration.

The historical audit compared 11 merged feedback PRs with current master, including their added prose and relevant HTML list structure. Four feedback items have confirmed regressions:

Feedback Prior fix Regression Restored content
DF-004 #2057 #2094 Android CONNECTION_STATE_FAILED recovery: leave, await DISCONNECTED, rejoin with a valid Token; Ex connection scope and -17 explanation
DF-017 #2053 #2094 Nest the ensure/checklist under INVALID_TOKEN (8), keeping reasons (9) onward in the same list
DF-015 #2060 #2094 Restore Windows/macOS primary-only capture guidance and the Windows sourceType-to-publishing-option mapping
DF-026 HarmonyOS #2073 #2111 Include agorasdk.log in the custom/default file path and clarify directory separators

This restores only the affected descriptions, not the release commits themselves. SDK versions, new APIs, source enum fixes from #2136 and all other release content remain intact. SnapshotConfig, renewToken, Metadata truncation, DataStream limits, Web UID links and mini-program event-parameter fixes were checked and remain present.

Missing source fixes are included in a companion DITA PR. Existing upstream connection-state fixes are regenerated rather than reauthored. The Chinese output is generated by the repository's customized Oxygen scenarios; only identified regression sections are transferred, excluding unrelated baseline generation drift. No frontend, release metadata or English docs are changed.

Validation:

  • Five changed DITA topics parse as XML; git diff --check passes in both repositories.
  • Four customized Oxygen scenarios report Transformation successful. Existing conditional-processing and legacy Harmony reference diagnostics remain; this is not a zero-warning build claim.
  • Structural assertions verify the Android nested checklist/recovery sequence, C++/macOS primary-only guidance, four-way source mapping and HarmonyOS log paths.
  • All 18 internal links in restored sections resolve to existing files/anchors.
  • All other bytes of the four HTML pages remain identical to current master outside the selected restoration sections.
  • Local HTTP/browser checks cover the four regenerated pages.

Production verification is pending publication.

Related PRs:

@Foesa-yyx
Foesa-yyx merged commit 474840c into master Oct 30, 2026
4 of 20 checks passed
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