fix(docs): use absolute URLs for images and links in the npm READMEs

[polaz]

Summary

npm joins relative README paths onto the repository URL. The READMEs published to npm used ../..-based paths, which resolved to GitHub page addresses: the donation QR code did not render on the npm page (the resolved URL returns 404) and the LICENSE, CONTRIBUTING and LICENSE.MIT links did not open the files.

• prepare-release.sh renders the npm READMEs (packages/gitlab-mcp, packages/gitlab-mcp-db) with absolute bases: raw.githubusercontent.com/.../HEAD for images, github.com/.../blob/HEAD for links.
• The root README, shown on the GitHub repository page, keeps relative paths.
• README.md.in has a separate __ASSET_BASE__ placeholder for images; the regenerated READMEs are included.

Testing

READMEs regenerated with prepare-release.sh; the new image and link URLs return 200 (the QR as image/svg+xml). The npm page picks the change up with the next published release.

Closes #612

Summary by CodeRabbit

• Documentation
  • Updated package README badges, contribution links, license links, and donation images to use appropriate project URLs.
  • Improved README generation so links and images resolve correctly in package and repository documentation.

[chatgpt-codex-connector]

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review	Status	Commit	Review trigger
📝 Code Review	✅ Completed 2026-09-25T16:20:33.095395Z	d1eeed6	PR opened

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

[coderabbitai]

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: structured-world/gitlab-mcp/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: a2c4e4fa-8450-4ec8-801c-4ad72f4d8a54

📥 Commits

Reviewing files that changed from the base of the PR and between 144d0ca and d1eeed6.

📒 Files selected for processing (4)

• packages/gitlab-mcp-db/README.md
• packages/gitlab-mcp/README.md
• packages/gitlab-mcp/README.md.in
• packages/gitlab-mcp/scripts/prepare-release.sh

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

README generation now uses separate bases for links and images. The generated package READMEs use absolute GitHub URLs, while the root README retains relative paths.

Changes

NPM README URL updates

Layer / File(s)	Summary
README URL bases packages/gitlab-mcp/README.md.in, packages/gitlab-mcp/scripts/prepare-release.sh	The template uses a separate base for image paths. The release script supplies absolute link and image bases for package READMEs and relative bases for the root README.
Generated package README links packages/gitlab-mcp/README.md, packages/gitlab-mcp-db/README.md	The package READMEs use absolute GitHub URLs for contribution, donation image, and license links.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Bug fix · Severity of issue fixed: Low

Merge Risk: ⚪ Minimal · up to d1eee

The package README links and QR image point to the intended repository files, while the root README keeps relative paths. No actionable merge-blocking risk was identified.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (3 skipped: 3 …	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: replacing relative URLs with absolute URLs for images and links in the npm READMEs.
Linked Issues check	✅ Passed	The PR satisfies the coding requirements in [#612]. prepare-release.sh uses blob/HEAD URLs for npm README links and raw.githubusercontent.com/.../HEAD URLs for images. The template uses `__ASSET…
Out of Scope Changes check	✅ Passed	The changed files are limited to the README template, the release README generator, and the two generated package READMEs. Each change supports [#612]. The root README remains unchanged. No unrelated …

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (3 skipped: 3 unsupported.)

• Fix all pre-merge checks with AI

✨ Finishing Touches 💡 1

📝 Generate docstrings 💡

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!