search

dart-lang / pub-dev

The pub.dev website
https://pub.dev
BSD 3-Clause "New" or "Revised" License
774 stars 145 forks source link

Better surface API docs in pub.dev #4761

Open jayoung-lee opened 3 years ago

jayoung-lee commented 3 years ago

Some users have said that they like Golang package site pkg.go.dev, where API docs are integrated with the site and presented front and center (example: http).

We can learn from the site and organize Flutter/Dart package documentation better.

Before taking any actions, we'd like to hear community members' thoughts on what they like about the Golang package site. Please comment on this issue, if you have anything to share. :)

themisir commented 3 years ago

That would be actually great. It would reduce a few clicks to actually found api docs for something. Also API Docmentation link points to api docs home page which also contains same README as pub.dev/packages/{package} which might make it a bit hard to found actual api docs (I've actually struggled to find where's api docs for the classes first times before knowing that I have to click on library name).