-
Notifications
You must be signed in to change notification settings - Fork 29.6k
Description
issue_link
Commit Hash
Target
stable
pr_link
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
- annotations appears twice dart-lang/dartdoc#3265
- Arrow keys do not iterate through search suggestions in order dart-lang/dartdoc#3204
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 the dev/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).