Skip to content
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

x/tools/gopls: make docs discoverable #68977

Open
adonovan opened this issue Aug 20, 2024 · 2 comments
Open

x/tools/gopls: make docs discoverable #68977

adonovan opened this issue Aug 20, 2024 · 2 comments
Labels
Documentation gopls Issues related to the Go language server, gopls. Tools This label describes issues relating to any tools in the x/tools repository.
Milestone

Comments

@adonovan
Copy link
Member

A Google search for "gopls features" or "Gopls: Code transformation features" still after several weeks doesn't turn up gopls' lovingly rewritten documentation. We should fix that.

Related: @hyangah will add a feature to VS Code to make the "Browse gopls feature documentation" command more prominent.

Also, @hyangah wonders whether the gopls markdown documentation should be canonically hosted not at GitHub but in pkg.go.dev. (I vaguely recall @rsc saying there was some reason we should not rely on pkgsite's markdown feature, but I forget what it was.) @hyangah suggested alternatively hosting them at go.dev/something.

@adonovan adonovan added gopls Issues related to the Go language server, gopls. Documentation labels Aug 20, 2024
@gopherbot gopherbot added the Tools This label describes issues relating to any tools in the x/tools repository. label Aug 20, 2024
@gopherbot gopherbot added this to the Unreleased milestone Aug 20, 2024
@adonovan adonovan modified the milestones: Unreleased, gopls/v0.17.0 Aug 20, 2024
@gabyhelp
Copy link

Related Issues and Documentation

(Emoji vote if this was helpful or unhelpful; more detailed feedback welcome in this discussion.)

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/614876 mentions this issue: gopls/doc: a web server for gopls markdown docs

@findleyr findleyr modified the milestones: gopls/v0.17.0, gopls/backlog Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation gopls Issues related to the Go language server, gopls. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Development

No branches or pull requests

4 participants