docs: eliminate onboarding workflow drift#70
Open
tri-pti wants to merge 1 commit into
Open
Conversation
Contributor
|
🎉 Congratulations on your first Pull Request! Thank you for contributing to open source! This is an exciting moment. 🌟 What happens next?
While you wait:
Thanks for being awesome! We're proud of you! 💪 |
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.
Pull Request
Description
This PR centralizes the onboarding workflow by making
QUICKSTART.mdthe canonical onboarding document. It removes duplicated onboarding instructions from other documentation files, adds a clear documentation ownership structure, and introduces a CI check to prevent future documentation drift.Related Issue
Closes #64
GitHub Username
GitHub Profile: @tri-pti
Type of Change
Contributor Checklist
Screenshots (if applicable)
N/A
Additional Notes
Changes included:
QUICKSTART.mdas the canonical onboarding guide.README.md,CONTRIBUTING.md, andFAQ.mdwith references toQUICKSTART.md.CONTRIBUTING.mdto define the responsibility of each documentation file.check-doc-drift.sh) and integrated it into the GitHub Actions workflow to detect duplicated onboarding instructions and help prevent future documentation drift.