Skip to content

Conversation

@tanishqasharma29
Copy link

This PR refines the README to improve clarity, technical accuracy, and contributor onboarding.
It adds a clear architecture overview, Docker-based quick start, transform lifecycle
documentation, and improved configuration and troubleshooting sections.
Screenshots
BEFORE
image
image

AFTER
image
image
image

No functional code changes included.

📌 This project is actively developed under Social Winter of Code (SWoC) 2026.

@sr-857
Copy link
Owner

sr-857 commented Jan 15, 2026

Thanks for the effort on improving the README and documentation. The write-up is detailed and clearly well intentioned.

That said, we won’t be merging this PR at this time. The scope and structure of the changes don’t align with the current direction of the project’s documentation, and we’re intentionally keeping onboarding and architecture docs lighter until the core APIs stabilize.

Please don’t take this as a reflection on the quality of your work — it’s appreciated. We may revisit similar improvements later once the project reaches that stage.

Closing this PR for now.

@sr-857 sr-857 closed this Jan 15, 2026
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