Skip to content

Conversation

@SUJAYSAKHARE22
Copy link

tried to update the readme.md file with proper documentation.

tried to update the readme.md file with proper documentation.
@kiview
Copy link
Member

kiview commented Aug 10, 2025

Hey @SUJAYSAKHARE22,
while I definitely appreciate you reaching out and trying to improve the README (which I agree, there is room for improvement), we generally would like to keep it small and especially avoid having code examples within the README, that are not executed as part of the CI. That's what our docs are for.

So I am going to close this PR, since I don't see us reviewing and merging such a big changeset. But feel free to elaborate on your motivation behind improving the README and consider discussing with us an approach, that would be based on small and focused changes.

@kiview kiview closed this Aug 10, 2025
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