42.1 F
Columbus
Tuesday, January 26, 2021

Pkg.go.dev has a new look!

This post was originally published on this site

Since launching pkg.go.dev, we’ve received a lot of great
feedback on design and usability.
In particular, it was clear that the way information was organized confused
users when navigating the site.

Today we’re excited to share a redesigned pkg.go.dev,
which we hope will be clearer and more helpful.
This blog post presents the highlights. For details,
see Go issue 41585.

Consistent landing page for all paths

The main change is that the pkg.go.dev/<path> page has been reorganized
around the idea of a path.
A path represents a directory in a particular version of a module.
Now, regardless of what’s in that directory,
every path page will have the same layout,
with the goal of making the experience consistently useful and predictable.

Landing page for cloud.google.com/go/storage
Fig 1. Landing page for
https://pkg.go.dev/cloud.google.com/go/storage.

The path page will display the README at that path if there is one.
Previously, the overview tab only showed the README if present at the module root.
This is one of many changes we’re making to place the most important information up front.

Documentation navigation

The documentation section now displays an index along with a sidenav.
This gives the ability to see the full package API,
while having context as they are navigating the documentation section.
There is also a new Jump To input box in the left sidenav,
to search for identifiers.

Jump To feature navigating net/http
Fig 2. Jump To feature on
https://pkg.go.dev/net/http.

See Go issue 41587 for details on changes in the documentation section.

Metadata on main page

The top bar on each page now shows additional metadata,
such as each package’s “imports” and “imported by” counts.
Banners also show information about the latest minor and major versions of a module.
See Go issue 41588 for details.

Header metadata for github.com/russross/blackfriday
Fig 3. Header metadata for
https://pkg.go.dev/github.com/russross/blackfriday.

Video Walkthrough

Last week at Google Open Source Live,
we presented a walkthrough of the new site experience in our talk,
Level Up: Go Package Discovery and Editor Tooling.

Feedback

We’re excited to share this updated design with you.
As always, please let us know what you think via the “Share Feedback”
and “Report an Issue” links at the bottom of every page of the site.

And if you’re interested in contributing to this project, pkg.go.dev is open source! Check out the
contribution guidelines
to find out more.

Related Articles

Announcing the launch of our Slack V.3 integration

In 2018, we released an integration between Stack Overflow for Teams and Slack. It’s now one of the most popular ways for users to...

IntelliJ IDEA 2020.3.2 Is Available

Our second bug-fix release for IntelliJ IDEA 2020.3.2 is out! You can upgrade to v2020.3.2 from the IDE, with the Toolbox App, or by...

Answering Your Questions: AMA with the .NET Team on Reddit

Last week, we held our first Ask Me Anything (AMA) session on Reddit. We’d like to thank everyone who participated, and we hope you...

LEAVE A REPLY

Please enter your comment!
Please enter your name here

Stay Connected

21,422FansLike
0FollowersFollow
0SubscribersSubscribe
- Advertisement -

Latest Articles

Announcing the launch of our Slack V.3 integration

In 2018, we released an integration between Stack Overflow for Teams and Slack. It’s now one of the most popular ways for users to...

IntelliJ IDEA 2020.3.2 Is Available

Our second bug-fix release for IntelliJ IDEA 2020.3.2 is out! You can upgrade to v2020.3.2 from the IDE, with the Toolbox App, or by...

Answering Your Questions: AMA with the .NET Team on Reddit

Last week, we held our first Ask Me Anything (AMA) session on Reddit. We’d like to thank everyone who participated, and we hope you...

WebStorm 2020.3.2 Is Available

WebStorm 2020.3.2, the second bug-fix update for WebStorm 2020.3, is now available! You can update to it using the Toolbox App or right from the...

Video: Refactoring Code With PhpStorm

Christoph Rumpel shows PhpStorm’s refactoring features. He goes through 6 refactorings to improve code readability and maintainability. https://youtube.com/watch?v=LamxHRmwK2Q PhpStorm tips with Christoph Rumpel is a video...