Skip to content

feat(skill): add root SKILL.md and document npx skills install#196

Merged
senamakel merged 1 commit into
tinyhumansai:mainfrom
Giri-Aayush:feat/skills-sh-discovery
Jun 26, 2026
Merged

feat(skill): add root SKILL.md and document npx skills install#196
senamakel merged 1 commit into
tinyhumansai:mainfrom
Giri-Aayush:feat/skills-sh-discovery

Conversation

@Giri-Aayush

@Giri-Aayush Giri-Aayush commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

What

Make the tinyplace skill cleanly discoverable by the skills ecosystem (npx skills, which powers the skills.sh directory and its leaderboard):

  1. Add a root-level SKILL.md as a relative symlink to sdk/SKILL.md (which itself resolves to the canonical website/public/SKILL.md). The skills CLI checks the repo root first, so this surfaces the skill at the top level instead of only through a recursive search, and gives the repo a cleaner directory page.
  2. Document installation in the README with a short "Use it as an agent skill" section: npx skills add tinyhumansai/tiny.place.

Why

skills.sh indexes public repos that contain a valid SKILL.md and ranks them by install volume; there is no submission form, so the install command (and clean top-level discovery) is how the skill gets surfaced. The skill is already published on ClawHub; this lines the GitHub repo up with the wider npx skills ecosystem (Claude Code, OpenClaw, Codex, Cursor, and 70+ other agents).

Notes

  • The canonical file is website/public/SKILL.md (served at tiny.place/SKILL.md). sdk/SKILL.md is already a symlink to it, and the new root SKILL.md symlinks to sdk/SKILL.md, so everything resolves to one file and nothing drifts.
  • No source, locale, or build changes, so CI lint / i18n / e2e are unaffected.

Verification

$ npx skills add tinyhumansai/tiny.place --list
Found 1 skill
  tinyplace

Confirmed the root symlink resolves to exactly one skill (tinyplace) via the skills CLI. All README links return HTTP 200.

Add a root-level SKILL.md (relative symlink to the canonical sdk/SKILL.md)
so the skills CLI and the skills.sh directory discover the tinyplace skill at
the top level instead of via a recursive search. Document installation via
`npx skills add tinyhumansai/tiny.place` in the README.

The symlink keeps a single source of truth (sdk/SKILL.md), so the root copy
never drifts. Verified: `npx skills add <repo> --list` resolves exactly one
skill (tinyplace) through the root symlink.
@vercel

vercel Bot commented Jun 26, 2026

Copy link
Copy Markdown

@Giri-Aayush is attempting to deploy a commit to the Vezures Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Add a README subsection for using the repository as an agent skill, including installation and SKILL.md references. Change SKILL.md to point to sdk/SKILL.md.

Changes

Agent skill usage

Layer / File(s) Summary
Skill entrypoint and usage docs
SKILL.md, README.md
SKILL.md now resolves to sdk/SKILL.md, and the README adds a subsection with the skills CLI install command, supported agents, and links to SKILL.md.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A bunny hops by, ears held high,
With skill-link trails beneath the sky.
README carrots, bright and neat,
Guide tiny paws to setup sweet.
SKILL.md now knows the path to take,
Hoppy little changes, for the skill's own sake.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main changes: adding a root SKILL.md and documenting npx skills installation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 71ea28d893

ℹ️ About Codex in GitHub

Codex has been enabled to automatically 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".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread SKILL.md
@@ -0,0 +1 @@
sdk/SKILL.md No newline at end of file

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Replace root symlink with a real skill file

When users or the skills.sh/blob install path fetch the root SKILL.md through GitHub raw, this symlink is served as the literal text sdk/SKILL.md, not as the target file's YAML frontmatter. The skills discovery flow fetches raw.githubusercontent.com/.../SKILL.md to parse name and description, so the new root entry can be skipped or installed as an invalid one-line skill in exactly the discovery path this change is meant to support; make the root path contain the actual SKILL.md content instead of a symlink.

Useful? React with 👍 / 👎.

@senamakel senamakel merged commit 5a8f880 into tinyhumansai:main Jun 26, 2026
7 of 10 checks passed
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.

2 participants