[CP] Update Dartdoc to fix API doc issues #117032
Labels
cp: approved
Approved cherry-pick request
cp: merge-to-stable
Cherry-picks that should be merged to stable
cp: review
Cherry-picks in the review queue
issue_link
dart-lang/dartdoc#3204
Commit Hash
96597c2
Target
stable
pr_link
#117030
Impacted Users
All users of the API docs website.
Impact Description
The impact of this change is that users can't easily navigate the search bar on the API docs website, and there is confusing duplication on some pages.
Fixed Issues
This fix is very low risk: it doesn't impact the produced Flutter code or tools at all, only the published API docs website (and not the flutter.dev website).
Workaround
The workaround is to direct people to the https://master-api.flutter.dev site until the fix reaches stable.
This is less than ideal, because it describes the master API, not the stable API, and that is likely to be confusing to users.
Risk
low
Test Coverage
yes
Validation Steps
Once published, the web site can be visited, and verified that it fixes the linked issues.
Before being published, it is possible to run the
dev/bots/docs.sh
script on a macOS or Linux workstation and view the site produced in thedev/docs/doc
folder, but unfortunately the locally published site doesn't have a functional search bar, so it's not possible to test for that fix, only the duplication fix (dart-lang/dartdoc#3265).The text was updated successfully, but these errors were encountered: