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

doc: add annotation examples #19

Merged
merged 4 commits into from
Mar 13, 2024
Merged

doc: add annotation examples #19

merged 4 commits into from
Mar 13, 2024

Conversation

Grraahaam
Copy link
Contributor

Description 📣

To help users to create great schemas, let's help them by providing use-case examples for every annotation. IMO I think we understand often faster and easier when we see how it works.

This PR includes :

  • improvements in the README file
    • simplify the annotation table and add link to their respective section
    • add annotation examples
    • add an example values.yaml with the required files to be able to reproduce and play with it
    • add args into the pre-commit config file, for users to be aware that they can customize it

Hope it helps ✌🏽

@dadav
Copy link
Owner

dadav commented Mar 13, 2024

Thanks for this PR, it looks awesome and will help other to understand the usage much better!!

@dadav dadav merged commit d8160c1 into dadav:main Mar 13, 2024
2 checks passed
@Grraahaam Grraahaam deleted the doc/examples branch March 14, 2024 09:43
@Grraahaam
Copy link
Contributor Author

With pleasure!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants