Clarify purpose and setup differences between atif/ and satvik/ implementations

[ironman1947]

Hello maintainers,

While setting up the project and following the README, I noticed that the repository contains two folders (atif/ and satvik/), each with its own setup process and requirements.txt.

Problem

As a new contributor, it is currently unclear:

• whether atif/ and satvik/ represent alternative pipelines, experimental implementations, or different stages of the project
• which implementation is recommended for getting started
• which dependency set should be installed first

Why this matters

This ambiguity can make onboarding difficult for new contributors and may lead to incorrect environment setup or duplicated effort.

Suggested improvement

• Briefly document the purpose of atif/ and satvik/ in the main README
• Indicate which implementation is recommended for new contributors
• Optionally clarify maintenance status (active / experimental)

[shauryam2807]

Hi! 👋

I’m Shauryam. I’d like to work on this issue by clarifying the purpose and setup differences between the atif/ and satvik/ folders. I’ll explore both implementations and update the main README with a clear explanation of what each folder is for, their setup steps, and which one is recommended for new contributors.

Please let me know if this approach sounds good, or if there’s anything specific you’d like me to focus on.

Thanks!

[ironman1947]

Hi @shauryam2807 , thanks for taking this up! 😊
Clarifying the purpose and setup differences between atif/ and satvik/ would definitely help new contributors.

I’ve also been exploring the repository structure while working on other documentation improvements, so happy to review or test the changes once your PR is up.

Thanks!

[shauryam2807]

Thanks for the encouragement! 😊
I’ll add a brief clarification in the docs outlining the purpose of atif/ and satvik/, their differences, and guidance for new contributors on where to start.

I’ll share the PR here once it’s ready
I really appreciate your review or testing feedback.

Thanks!

[Mayan10]

Hi! I've opened a PR that addresses this issue by adding a dedicated Repository Structure section to the README, with a comparison table, per-folder setup instructions, and clear onboarding guidance for new contributors. PR link: #27 (comment)
Happy to revise based on any feedback!