Skip to content

docs: add better documentation#1028

Merged
phm07 merged 15 commits into
mainfrom
docs
May 9, 2025
Merged

docs: add better documentation#1028
phm07 merged 15 commits into
mainfrom
docs

Conversation

@phm07
Copy link
Copy Markdown
Contributor

@phm07 phm07 commented Apr 4, 2025

This PR adds documentation based on https://diataxis.fr/

@phm07 phm07 self-assigned this Apr 4, 2025
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.38%. Comparing base (86f4a53) to head (9f8916e).
Report is 7 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1028   +/-   ##
=======================================
  Coverage   70.38%   70.38%           
=======================================
  Files         247      247           
  Lines       10867    10867           
=======================================
  Hits         7649     7649           
  Misses       2543     2543           
  Partials      675      675           
Flag Coverage Δ
e2e 50.64% <ø> (-0.03%) ⬇️
unit 63.32% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 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.

@phm07 phm07 marked this pull request as ready for review April 24, 2025 14:46
@phm07 phm07 requested a review from a team as a code owner April 24, 2025 14:46
Copy link
Copy Markdown
Member

@jooola jooola left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did a first pass, look great already!

Comment thread docs/README.md Outdated
Comment thread docs/guides/using-output-options.md Outdated
Comment thread docs/guides/using-output-options.md Outdated
Comment thread docs/guides/using-output-options.md
Comment thread docs/tutorials/create-a-server.md
Comment thread docs/tutorials/create-a-server.md Outdated
Comment thread docs/tutorials/setup-hcloud-cli.md
Comment thread docs/README.md Outdated
Comment thread docs/guides/using-output-options.md
Copy link
Copy Markdown
Member

@apricote apricote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work! In a follow up step this should be linked to from the main README.md and maybe we can replace/move some of its content to docs/

@phm07 phm07 merged commit a6a63d8 into main May 9, 2025
6 checks passed
@phm07 phm07 deleted the docs branch May 9, 2025 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants