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

Jump to bottom

x/tools/gopls: improve documentation #41591

Closed
stamblerre opened this issue Sep 23, 2020 · 3 comments
Closed

x/tools/gopls: improve documentation #41591

stamblerre opened this issue Sep 23, 2020 · 3 comments
Labels
Documentation FrozenDueToAge gopls Issues related to the Go language server, gopls. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
vscode-go: gopls by default

Comments

@stamblerre
Copy link
Contributor

Our current documentation is not very user-friendly and rarely updated.
We should add more information about workflows, features, example configurations, etc.
We should also try to autogenerate as much as possible (#33544).
@stamblerre stamblerre added this to the gopls/v1.0.0 milestone Sep 23, 2020
@gopherbot gopherbot added Tools This label describes issues relating to any tools in the x/tools repository. gopls Issues related to the Go language server, gopls. Documentation labels Sep 23, 2020
@stamblerre stamblerre mentioned this issue Sep 23, 2020
Closed
@ainar-g
Copy link
Contributor

ainar-g commented Sep 23, 2020

Will the code actions be documented in this issue as well, or should I file a separate one?

Also, I think I'll be able to contribute some docs regarding Neovim's (currently nightly-only) native LSP support in the next few days. Whom should I set as a reviewer?

@stamblerre
Copy link
Contributor Author

I think we can include an overview of code actions as part of this documentation effort.
You can feel free to add me as a reviewer, but you can also not assign a reviewer and one will get added automatically.

@stamblerre stamblerre added this to Needs Triage in vscode-go: gopls by default Nov 10, 2020
@stamblerre stamblerre moved this from Needs Triage to Critical in vscode-go: gopls by default Nov 10, 2020
@stamblerre stamblerre moved this from Critical to Documentation in vscode-go: gopls by default Nov 10, 2020
@stamblerre
Copy link
Contributor Author

This issue is probably too general to be useful for tracking purposes. We have made a number of documentation improvements recently, and we are currently working on more. Will close this as a result. If anyone has concerns about our existing documentation, please file a new issue.

vscode-go: gopls by default automation moved this from Documentation to Done Jan 16, 2021
@golang golang locked and limited conversation to collaborators Jan 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge gopls Issues related to the Go language server, gopls. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
No open projects
vscode-go: gopls by default
  
Done
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ainar-g @stamblerre @gopherbot