commit | 254ae6f648897483d05a3d2f7d6c35e1b80f4357 | [log] [tgz] |
---|---|---|
author | Michael Matloob <matloob@golang.org> | Wed Dec 20 12:37:35 2023 -0500 |
committer | Michael Matloob <matloob@golang.org> | Thu Dec 21 16:03:52 2023 +0000 |
tree | 9fd89261b010cedbd9eaceed790614cccba0c3f9 | |
parent | 4356cead6cb7f398ddc8ea3e9bcbd2ce15c0b504 [diff] |
cmd/pkgsite,internal/fetch: improve startup experience When a user tries to look at the documentation for a unit for the first time, we process all the packages in the module. Kick off goroutines to do that so that the modules' packages might be processed by the time the user sees them. Also parallelize processing the packages in the module. That brings processing std from about 8 seconds to about 3 seconds. Change-Id: I505979d682897d2d1e55ce9e123e3ff4d1fb0e70 Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/551776 kokoro-CI: kokoro <noreply+kokoro@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Jonathan Amsterdam <jba@google.com>
This repository hosts the source code of the pkg.go.dev website, and pkgsite
, a documentation server program.
Pkg.go.dev is a website for discovering and evaluating Go packages and modules.
You can check it out at https://pkg.go.dev.
pkgsite
program extracts and generates documentation for Go projects.
Example usage:
$ go install golang.org/x/pkgsite/cmd/pkgsite@latest $ cd myproject $ pkgsite -open .
For more information, see the pkgsite documentation.
Pkgsite requires Go 1.19 to run. The last commit that works with Go 1.18 is 9ffe8b928e4fbd3ff7dcf984254629a47f8b6e63. The last commit that works with Go 1.17 is 4d836c6a652cde92f433967680dfd6171a91ec12.
If you want to report a bug or have a feature suggestion, please first check the known issues to see if your issue is already being discussed. If an issue does not already exist, feel free to file an issue.
For answers to frequently asked questions, see pkg.go.dev/about.
You can also chat with us on the #pkgsite Slack channel on the Gophers Slack.
We would love your help!
Our canonical Git repository is located at go.googlesource.com/pkgsite. There is a mirror of the repository at github.com/golang/pkgsite.
To contribute, please read our contributing guide.
Unless otherwise noted, the Go source files are distributed under the BSD-style license found in the LICENSE file.