-
Notifications
You must be signed in to change notification settings - Fork 28.6k
Would be nice if each API documentation page had a mechanism for providing feedback #127361
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
Comments
I realized that most of the non-API-documentation pages have "File Issue" links (e.g. https://flutter.io/widgets/), so the API documentation pages should do the same for consistency. |
This feature is currently blocked by dart-lang/dartdoc#1454. Please consider upvoting that issue. |
dart-lang/dartdoc#1454 would definitely help, but I don't think it's a strict requirement. As a first step, being able to file a GitHub issues that includes the URL to the documentation page itself would be an improvement. Once dart-lang/dartdoc#1454 is fixed, then the new issue can reference the source file directly. |
Agreed. I wonder if this requires changes to DartDoc. Cc: @gspencergoog @jcollins-g |
Filed as dart-lang/dartdoc#1815. |
It would be nice if each API documentation page included a link for providing feedback or corrections for the page, similar to MSDN or for what we do for internal g3doc pages. At a minimum it could be a link that starts a GitHub issue with the URL of the page, like: https://github.com/flutter/flutter/issues/new?title=API%20Documentation%20Feedback&body=Feedback%20for%20http%3A%2F%2Fwww.example.com
(Originally filed as flutter/website#1438 )
The text was updated successfully, but these errors were encountered: