Docs: clarify setup, workflow, and contribution guidance in README - #6
Open
pranjal2004838 wants to merge 1 commit into
Open
Docs: clarify setup, workflow, and contribution guidance in README#6pranjal2004838 wants to merge 1 commit into
pranjal2004838 wants to merge 1 commit into
Conversation
…d youtube_pipeline repo better
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the README to make the YouTube caption processing pipeline more approachable for new users and contributors.
The changes focus on clarifying the project’s purpose, simplifying the workflow explanation, and making setup assumptions more explicit, without modifying any code or research logic.
What changed
Why this change
The original README is accurate but assumes familiarity with the research environment and tooling. These documentation updates aim to reduce onboarding friction for:
Scope
Please let me know if you’d prefer any adjustments to tone or structure.