Improve README accuracy and links

[glenn-jocher]

Summary

• aligns README setup and run instructions with source/run_repo.py
• replaces generic docs README content with source-trace-specific usage notes
• retargets the contributors image link to this repository

Validation

• git diff --check
• lychee README.md docs/README.md
• python -m compileall -q .

🛠️ PR Summary

_{Made with ❤️ by Ultralytics Actions}

🌟 Summary

This PR simplifies and corrects the source-trace documentation so users can quickly configure repository comparisons and run the tool directly 🚀

📊 Key Changes

• Updated the main README.md setup steps to point users to the real workflow in source/run_repo.py instead of generic docs/ guidance.
• Added explicit configuration instructions for key comparison settings:
  • SOURCE_REPO
  • DEST_REPO
  • SUFFIXES
  • ignore lists in source/run_repo.py
• Clarified how to run the tool with a direct command: python source/run_repo.py ▶️
• Reworked docs/README.md to reflect the current state of the project:
  • Removed outdated MkDocs-related documentation 🧹
  • Explained that the repository does not currently include an MkDocs site or mkdocs.yml
  • Replaced it with practical usage notes tied to the actual script
• Fixed the contributors badge link in README.md so it now points to the correct ultralytics/source-trace contributors page 🔗

🎯 Purpose & Impact

• Makes onboarding easier by giving users accurate, actionable setup steps instead of outdated documentation 🙌
• Reduces confusion for new contributors and users who might otherwise look for a non-existent MkDocs site.
• Aligns the docs with how the project actually works today, improving trust and usability ✅
• Helps users get started faster with repository comparison and code-trace analysis, with fewer setup mistakes ⚡
• Improves project polish by correcting repository-specific links and removing misleading instructions 🛠️

[UltralyticsAssistant]

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/source-trace 🚀 PR! This is an automated message to help with review readiness—an engineer will assist you shortly. Please review the checklist below:

• ✅ Define a Purpose: Clearly explain the purpose of your fix or feature in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
• ✅ Synchronize with Source: Confirm your PR is synchronized with the ultralytics/source-trace main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
• ✅ Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
• ✅ Update Documentation: Update the relevant documentation for any new or modified features.
• ✅ Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
• ✅ Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR by writing "I have read the CLA Document and I sign the CLA" in a new message.
• ✅ Minimize Changes: Limit your changes to the minimum necessary for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

For more guidance, please refer to our Contributing Guide. Don’t hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! 🚀

[UltralyticsAssistant]

🔍 PR Review

_{Made with ❤️ by Ultralytics Actions}

Documentation-only PR looks clean. The updated README guidance matches the current repository layout and removes the incorrect MkDocs/contributors references without introducing any actionable issues in the diff. (github.com)

[UltralyticsAssistant]

Merged! 🎉 Thanks, @glenn-jocher, for sharpening the source-trace docs and making the real setup and execution flow much clearer.

As Leonardo da Vinci said, “Simplicity is the ultimate sophistication.” This PR reflects that well by removing outdated guidance, pointing users to the actual source/run_repo.py workflow, and making onboarding faster and more trustworthy for everyone.

Really appreciate the thoughtful cleanup, clearer configuration instructions, and the small but important link fixes that improve the overall contributor experience.