Skip to content

[CP] Update Dartdoc to fix API doc issues #117032

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
gspencergoog opened this issue Dec 14, 2022 · 2 comments
Closed

[CP] Update Dartdoc to fix API doc issues #117032

gspencergoog opened this issue Dec 14, 2022 · 2 comments
Assignees
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

Comments

@gspencergoog
Copy link
Contributor

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 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).

@gspencergoog gspencergoog added the cp: review Cherry-picks in the review queue label Dec 14, 2022
@gspencergoog
Copy link
Contributor Author

cc @goderbauer

@CaseyHillers CaseyHillers added the cp: approved Approved cherry-pick request label Dec 14, 2022
@CaseyHillers CaseyHillers added the cp: merge-to-stable Cherry-picks that should be merged to stable label Dec 14, 2022
@github-actions
Copy link

github-actions bot commented Mar 4, 2023

This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of flutter doctor -v and a minimal reproduction of the issue.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 4, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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
Projects
None yet
Development

No branches or pull requests

3 participants