docs: link readme to docs#1059
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1059 +/- ##
==========================================
- Coverage 70.36% 63.30% -7.07%
==========================================
Files 247 245 -2
Lines 10870 10808 -62
==========================================
- Hits 7649 6842 -807
- Misses 2544 3244 +700
- Partials 677 722 +45
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| to get, list, set and unset configuration options and preferences. You can view a list | ||
| of all available options and preferences by running `hcloud config --help`. |
There was a problem hiding this comment.
Can we link to docs/reference/manual/hcloud_config.md#synopsis here? Its now available in the repo directly.
(Also just noticed that the formatting of that page is broken)
There was a problem hiding this comment.
Yeah, that makes sense.
About the formatting, we could either wrap the table in a code block or change the table formatting to a markdown compatible format (making the CLI help output less pretty though). Which option do you prefer?
| You can download pre-built binaries for Linux, FreeBSD, macOS, and Windows on | ||
| the [releases page](https://github.com/hetznercloud/cli/releases). | ||
| - See [setting up hcloud](docs/tutorials/setup-hcloud-cli.md) for instructions on how to install and configure the CLI. | ||
| - See the [manual](docs/reference/manual) for a list of all available commands and their options. |
There was a problem hiding this comment.
What do you think about linking to the docs/reference/manual/hcloud.md instead? It feels nicer than the huge list of commands.
There was a problem hiding this comment.
Yep, sorry, wasn't thinking :D
2 participants
This PR cleans up the readme, links to the docs where needed and also moves the configuration help text to
docs/reference.