Skip to content

docs: add the skills.sh install badge to the README - #206

Merged
bagowix merged 1 commit into
mainfrom
docs/skills-badge
Sep 10, 2026
Merged

bagowix merged 1 commit into
mainfrom
docs/skills-badge

Conversation

@bagowix

@bagowix bagowix commented Sep 10, 2026

Copy link
Copy Markdown
Owner

Summary

Adds the official skills.sh badge to the README badge row, next to the llms.txt and Context7 badges, the other two entry points for agents. It renders the install count skills.sh aggregates from the skills CLI for the Agent Skill shipped in #205, and links to the repository's page on skills.sh, which carries the npx skills add bagowix/interlock command. The badge endpoint started returning data today after the first install; before that it rendered "resource not found", which is why this waited for the merge of #205.

No changelog entry, following #75, which added the documentation and Context7 badges the same way.

Checklist

  • Tests added or updated (suite stays at 100% coverage): no code changes; the suite is untouched
  • uv run ruff format --check and uv run ruff check pass
  • uv run mypy, uv run pyright and uv run pyrefly check pass
  • Docs updated (docs/) for user-facing changes: README only, the docs landing page carries no badge row
  • CHANGELOG.md [Unreleased] updated: deliberately not, see above
  • Commits follow Conventional Commits

Related issues

None.

Added

  • Add the official skills.sh install badge to the README badge row.
  • Link the badge to the bagowix/interlock skills.sh page.

The Agent Skill shipped in #205 is listed on skills.sh, which counts
installs made through the skills CLI. The official badge sits next to
the llms.txt and Context7 badges, the other two entry points for agents.
@coderabbitai

coderabbitai Bot commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 042c8342-405f-46b3-966a-fa03add493cb

📥 Commits

Reviewing files that changed from the base of the PR and between a4e8206 and 5417d41.

📒 Files selected for processing (1)
  • README.md

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

📜 Recent review details
⏰ Context from checks skipped due to timeout. (16)
  • GitHub Check: CodeQL
  • GitHub Check: github-advanced-security
  • GitHub Check: quality (3.12)
  • GitHub Check: quality (3.14t)
  • GitHub Check: quality (3.13)
  • GitHub Check: Platform smoke (macos-latest, Python 3.11)
  • GitHub Check: quality (3.11)
  • GitHub Check: Platform smoke (windows-latest, Python 3.14)
  • GitHub Check: Coverage
  • GitHub Check: Platform smoke (macos-latest, Python 3.14)
  • GitHub Check: Platform smoke (windows-latest, Python 3.11)
  • GitHub Check: quality (3.14)
  • GitHub Check: Extras (minimum versions)
  • GitHub Check: Run benchmarks
  • GitHub Check: Analyze (actions)
  • GitHub Check: Analyze (python)
🧰 Additional context used
📓 Path-based instructions (1)
Document user-facing changes in English Markdown documentation and keep generated documentation mirrors synchronized.

📄 CodeRabbit inference engine (AGENTS.md)

Files:

  • README.md
🔇 Additional comments (1)
README.md (1)

15-15: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Fix the badge destination URL.

The /b/bagowix/interlock path is the badge image endpoint. Use /bagowix/interlock as the link target; otherwise, clicking the badge opens the SVG instead of the repository page. (skills.sh)

Proposed fix
-[![skills.sh](https://skills.sh/b/bagowix/interlock)](https://skills.sh/b/bagowix/interlock)
+[![skills.sh](https://skills.sh/b/bagowix/interlock)](https://skills.sh/bagowix/interlock)

Likely an incorrect or invalid review comment.

Source: MCP tools


Walkthrough

The README badge row now includes a skills.sh badge linked to the repository page.

Changes

Documentation update

Layer / File(s) Summary
Add skills.sh badge
README.md
The badge row includes a skills.sh badge and repository link.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested labels: documentation

Merge Risk: ⚪ Minimal · up to 5417d

This documentation-only change adds a skills.sh install badge linking to the repository page and is ready to merge.

🚥 Pre-merge checks | ✅ 8 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Changelog Entry ⚠️ Warning The PR changes README.md, so it is outside the listed exemption paths. The head subject is docs: add the skills.sh install badge to the README, not chore: prepare the * release. The review diff co… Add a bullet under ## [Unreleased] in CHANGELOG.md that describes the user-visible skills.sh badge and its link or install-count information.
✅ Passed checks (8 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title follows the required Conventional Commits format and accurately describes the README badge change. It uses the allowed lowercase type "docs", an imperative summary, no trailing period, and 5…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Zero-Dependency Core ✅ Passed Only README.md changes in the reviewed range. No file under interlock/ changed, pyproject.toml still has dependencies = [], and interlock/init.py does not re-export interlock.integrations.
Docs And Llm Mirror ✅ Passed The reviewed range changes only README.md by adding a skills.sh badge. It does not change public API code under interlock/, an integration, or configuration options. The docs/llms-full.txt regeneratio…
Tests Accompany Behaviour Change ✅ Passed The pull request changes only README.md. The exact reviewed diff contains no .py file under interlock/ and no production behavior change. The test requirement is therefore not triggered.
Public Api Surface ✅ Passed The authoritative PR diff changes only README.md by adding one badge. interlock/init.py and interlock/pipeline.py are unchanged, so no exported symbol was removed or had its signature changed.
Full details: Changelog Entry

Explanation

The PR changes README.md, so it is outside the listed exemption paths. The head subject is docs: add the skills.sh install badge to the README, not chore: prepare the * release. The review diff contains no CHANGELOG.md change, so it does not add a bullet under ## [Unreleased].

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/skills-badge

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

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

@codspeed

codspeed Bot commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Merging this PR will not alter performance

✅ 28 untouched benchmarks


Comparing docs/skills-badge (5417d41) with main (a4e8206)

Open in CodSpeed

@codecov

codecov Bot commented Sep 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@bagowix
bagowix merged commit d928804 into main Sep 10, 2026
21 of 22 checks passed
@bagowix
bagowix deleted the docs/skills-badge branch September 10, 2026 18:39
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.

1 participant