Skip to content

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

Open
jamesderlin opened this issue Oct 11, 2018 · 6 comments
Labels
c: new feature Nothing broken; request for a new capability d: api docs Issues with https://api.flutter.dev/ framework flutter/packages/flutter repository. See also f: labels. P3 Issues that are less important to the Flutter project team-framework Owned by Framework team triaged-framework Triaged by Framework team

Comments

@jamesderlin
Copy link
Contributor

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 )

@jamesderlin jamesderlin added the d: api docs Issues with https://api.flutter.dev/ label Oct 11, 2018
@jamesderlin
Copy link
Contributor Author

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.

@InMatrix
Copy link

This feature is currently blocked by dart-lang/dartdoc#1454. Please consider upvoting that issue.

@jamesderlin
Copy link
Contributor Author

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.

@InMatrix
Copy link

As a first step, being able to file a GitHub issues that includes the URL to the documentation page itself would be an improvement.

Agreed. I wonder if this requires changes to DartDoc. Cc: @gspencergoog @jcollins-g

@jcollins-g
Copy link
Contributor

Filed as dart-lang/dartdoc#1815.

@zoechi zoechi added the framework flutter/packages/flutter repository. See also f: labels. label Dec 11, 2018
@SogoGolf
Copy link

SogoGolf commented Dec 27, 2018

Microsoft Azure do this really well with large, clear "Feedback" widget at bottom of each developer docs page. What I really like about that is that it keeps the developer (me!) right in the context of what I'm doing/looking for - rather than having to go across to Github, maybe login, find the right repo, open a ticket,..etc etc etc

Here is a screenshot of what I'm referring to on Microsoft Azure. Something similar would be brilliant and super helpful for Flutter.

image

Finding the Flutter equivalent was for me at least not obvious.
image

Perhaps just use Firebase's - perfect !

image

@goderbauer goderbauer removed the framework flutter/packages/flutter repository. See also f: labels. label Jan 3, 2019
@Hixie Hixie added the framework flutter/packages/flutter repository. See also f: labels. label Mar 6, 2019
@kf6gpe kf6gpe added the c: new feature Nothing broken; request for a new capability label Jul 22, 2020
@atsansone atsansone transferred this issue from flutter/flutter Nov 11, 2022
@atsansone atsansone transferred this issue from flutter/website May 22, 2023
@goderbauer goderbauer added the P3 Issues that are less important to the Flutter project label May 30, 2023
@flutter-triage-bot flutter-triage-bot bot added team-framework Owned by Framework team triaged-framework Triaged by Framework team labels Jul 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: new feature Nothing broken; request for a new capability d: api docs Issues with https://api.flutter.dev/ framework flutter/packages/flutter repository. See also f: labels. P3 Issues that are less important to the Flutter project team-framework Owned by Framework team triaged-framework Triaged by Framework team
Projects
None yet
Development

No branches or pull requests

8 participants