Fix and augment relative links in MD files to GitHub blob URLs

[Borda]

This pull request standardizes and simplifies the way internal documentation and badges link to the project's license and other files, switching from absolute GitHub URLs to relative paths. It also introduces a script to augment relative links in markdown files to point directly to GitHub URLs, and updates the build workflow to use this script for the README.md. These changes improve maintainability and ensure that links work both locally and on GitHub.

Link standardization and simplification:

• Updated license badge and documentation links in README.md and docs/index.md to use relative paths instead of full GitHub URLs, making them more robust and easier to maintain. [1] [2] [3] [4] [5] [6]
• Changed the license link in CONTRIBUTING.md to use a relative path, aligning it with the new standard.
• Updated the "end-to-end examples" link in README.md to use a relative path.

Automation and workflow improvements:

• Added a new script, .github/scripts/augment_links.py, which converts relative links in markdown files to GitHub URLs, automating link management in documentation.
• Modified the build workflow (.github/workflows/build-package.yml) to run a script that augments paths in the README.md, ensuring that links are correctly formatted before distribution.

[Borda]

waiting for #2050

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71%. Comparing base (86b268d) to head (42f7624).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff           @@
##           develop   #2061   +/-   ##
=======================================
  Coverage       71%     71%           
=======================================
  Files           61      61           
  Lines         7152    7152           
=======================================
  Hits          5106    5106           
  Misses        2046    2046           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Pull request overview

This PR converts hardcoded GitHub blob URLs in markdown files to relative links, and introduces a script to augment these relative links back to GitHub URLs during the package build process. This approach allows for better maintainability of documentation while ensuring published documentation still contains full GitHub URLs.

Changes:

• Convert GitHub blob URLs to relative links in markdown documentation files
• Add a Python script to augment relative links to GitHub URLs during builds
• Integrate the augmentation script into the package build workflow

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
docs/index.md	Converted 4 GitHub blob URLs for LICENSE.md to relative paths (../LICENSE.md)
README.md	Converted GitHub URLs to relative paths for LICENSE.md, examples directory, and CONTRIBUTING.md
CONTRIBUTING.md	Converted GitHub blob URL for LICENSE.md to relative path (./LICENSE.md)
.github/scripts/augment_links.py	New Python script to convert relative links in markdown files to GitHub blob/tree URLs
.github/workflows/build-package.yml	Added workflow step to run the augmentation script on README.md before building package

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.