Skip to content

docs: eliminate onboarding workflow drift#70

Open
tri-pti wants to merge 1 commit into
The-Data-Nerds:mainfrom
tri-pti:docs/eliminate-onboarding-drift
Open

docs: eliminate onboarding workflow drift#70
tri-pti wants to merge 1 commit into
The-Data-Nerds:mainfrom
tri-pti:docs/eliminate-onboarding-drift

Conversation

@tri-pti

@tri-pti tri-pti commented Jul 8, 2026

Copy link
Copy Markdown

Pull Request

Description

This PR centralizes the onboarding workflow by making QUICKSTART.md the 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

  • Documentation update
  • Added my name to contributors list
  • Bug fix
  • Enhancement
  • Other (please specify)

Contributor Checklist

  • I have read the CONTRIBUTING.md guidelines
  • I have followed the repository contribution process
  • I have added my name in the correct format (if applicable)
  • My changes do not introduce unnecessary modifications
  • I have reviewed my changes before submitting

Screenshots (if applicable)

N/A


Additional Notes

Changes included:

  • Designated QUICKSTART.md as the canonical onboarding guide.
  • Replaced duplicated onboarding workflow sections in README.md, CONTRIBUTING.md, and FAQ.md with references to QUICKSTART.md.
  • Added a documentation ownership structure in CONTRIBUTING.md to define the responsibility of each documentation file.
  • Added a CI documentation consistency check (check-doc-drift.sh) and integrated it into the GitHub Actions workflow to detect duplicated onboarding instructions and help prevent future documentation drift.

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

🎉 Congratulations on your first Pull Request!

Thank you for contributing to open source! This is an exciting moment. 🌟

What happens next?

  1. A maintainer will review your PR (usually within 24-48 hours)
  2. They might request some changes - don't worry, this is normal!
  3. Once approved, your PR will be merged
  4. You'll officially be an open source contributor! 🎊

While you wait:

  • ⭐ Star this repository if you haven't already
  • 📖 Check out RESOURCES.md for your next steps
  • 💬 Share your achievement on social media with #MyFirstPR

Thanks for being awesome! We're proud of you! 💪

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.

[BUG]: [MAINTAINABILITY] Eliminate onboarding workflow drift across README, QUICKSTART, FAQ, and CONTRIBUTING

1 participant