Skip to content

docs: clarify purpose and setup of Atif/ and Satvik/ folders for new …#27

Open
Mayan10 wants to merge 1 commit into
humanai-foundation:mainfrom
Mayan10:docs/clarify-folder-structure
Open

docs: clarify purpose and setup of Atif/ and Satvik/ folders for new …#27
Mayan10 wants to merge 1 commit into
humanai-foundation:mainfrom
Mayan10:docs/clarify-folder-structure

Conversation

@Mayan10

@Mayan10 Mayan10 commented Feb 15, 2026

Copy link
Copy Markdown

Summary

This PR addresses issue #9 by improving the main README with clear documentation
of the Atif/ and Satvik/ folders.

Changes Made

  • Added a Repository Structure section to the README
  • Explained that both folders are parallel experimental pipelines (not sequential stages)
  • Added a comparison table for each folder: author, approach, and maintenance status
  • Added quick setup instructions (pip install -r requirements.txt) per folder
  • Added a clear "For New Contributors" section recommending Atif/ as the starting point
  • Added a note about using separate virtual environments when testing both folders

Why This Helps

New contributors can now immediately understand the purpose of each folder,
how to set it up, and where to begin — reducing onboarding friction.

Fixes #9

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.

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

1 participant