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

Clean up documentation #7

Merged
merged 8 commits into from
Dec 10, 2024
Merged

Conversation

jacobtomlinson
Copy link
Member

  • Cleaned up README and docs index
  • Added Markdown example syntax
  • Moved example to separate page
  • Added a hello world chart to the docs to make the example clearer

@jacobtomlinson jacobtomlinson added the documentation Improvements or additions to documentation label Dec 10, 2024
Copy link

codecov bot commented Dec 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@bb5f61b). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main       #7   +/-   ##
=======================================
  Coverage        ?   73.97%           
=======================================
  Files           ?        6           
  Lines           ?      196           
  Branches        ?        0           
=======================================
  Hits            ?      145           
  Misses          ?       51           
  Partials        ?        0           

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

@jacobtomlinson jacobtomlinson merged commit 6d5ee31 into kr8s-org:main Dec 10, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant