Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Document the --health command #1822

Closed
EricCrosson opened this issue Mar 16, 2022 · 2 comments
Closed

Document the --health command #1822

EricCrosson opened this issue Mar 16, 2022 · 2 comments
Labels
A-documentation Area: Documentation improvements C-enhancement Category: Improvements E-good-first-issue Call for participation: Issues suitable for new contributors

Comments

@EricCrosson
Copy link
Contributor

PR #1669 introduced the hx --health command, which I used tonight to help a friend diagnose LSP on his machine. It works to great effect! But I had to look at the PR to find the following information about the color-coded output:

(red for not found, green for found, yellow for no configuration)

and noticed the --health command isn't documented on the web documentation anywhere.

I took a quick look to see if I could add this documentation myself but couldn't come up with a strong opinion on where it should live.

@sudormrfbin
Copy link
Member

We could add a separate troubleshooting section and mention it there, with a link to it from the installation section. It's also possible to run hx --health LANG to see diagnostics for a particular language, whereas hx --health is meant to give a bird's eye view of everything.

@kirawi kirawi added A-documentation Area: Documentation improvements C-enhancement Category: Improvements E-good-first-issue Call for participation: Issues suitable for new contributors labels Mar 17, 2022
@EricCrosson
Copy link
Contributor Author

Closed by #2357 -- thanks @RobWalt!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
A-documentation Area: Documentation improvements C-enhancement Category: Improvements E-good-first-issue Call for participation: Issues suitable for new contributors
Projects
None yet
Development

No branches or pull requests

3 participants