docs: add headers and review

[svenja11]

No description provided.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.08%. Comparing base (5b68ce0) to head (a5bdaa3).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1478   +/-   ##
=======================================
  Coverage   73.08%   73.08%           
=======================================
  Files         301      301           
  Lines       11097    11097           
=======================================
  Hits         8110     8110           
  Misses       2090     2090           
  Partials      897      897           

Flag	Coverage Δ
e2e	51.46% <ø> (ø)
unit	67.93% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[jooola]

What is the reason for breaking the sections with titles into a numbered list and adding the many html elements?

[svenja11]

This is the formatting we use in the docs (see Using S3 compatible CLI tools, for example). I updated it like this so that the formatting is consistent. We usually use <details> when there are a lot of options, because it helps readers see all options at a glance, and makes the content easier to navigate in the docs.

[jooola]

Is there a way to find a middle ground between the format we had, and the one in the docs? Because now the tutorial does not look great on Github:

Before: https://github.com/hetznercloud/cli/blob/5b68ce0ae339987d6f42cd9a7cb9533be6354fb1/docs/tutorials/setup-hcloud-cli.md
After: https://github.com/hetznercloud/cli/blob/bd387d58bfdfeafb7003733f7e2dcac1913d9454/docs/tutorials/setup-hcloud-cli.md

In Github, having titles for the sections automatically generates a "Table of content" for the users:

I feel like the markdown document is not the right place for fixing styling issues (e.g. adding <br> to have more space between paragraphs), could we maybe fix this in the docs code directly?

[svenja11]

I thought about it for a bit but I can't really think of a good in-between. If this formatting is causing issues on GitHub, I guess we can go back to the original formatting.