Skip to content

Add skills setup info to docs#2823

Open
Harjun751 wants to merge 4 commits intoMarkBind:masterfrom
Harjun751:add-skills-setup-info-to-docs
Open

Add skills setup info to docs#2823
Harjun751 wants to merge 4 commits intoMarkBind:masterfrom
Harjun751:add-skills-setup-info-to-docs

Conversation

@Harjun751
Copy link
Contributor

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • DevOps
  • Improve developer experience
  • Others, please explain:

Overview of changes:

Update developer documentation on how to setup tool-specific skills directory. Also update .gitignore to exclude commonly used configuration directories.

Anything you'd like to highlight/discuss:

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)

Add AI skills setup info to developer docs


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

Reviewer checklist:

Indicate the SEMVER impact of the PR:

  • Major (when you make incompatible API changes)
  • Minor (when you add functionality in a backward compatible manner)
  • Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

  • To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

  • what was the old feature that was made obsolete
  • any replacement feature (if any), and
  • how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

To support workflow for setting up skills locally,
a symlink is suggested to be created in the
root directory. These files should not be
committed.

Add common directories for skills configuration.
Docs mention that skills live in .github/skills but
most if not all tools don't support this.

Add information on how to set up a symlink to
get desired skill functionality.
@codecov
Copy link

codecov bot commented Feb 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.18%. Comparing base (58f396f) to head (ce3b3a1).
⚠️ Report is 7 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2823      +/-   ##
==========================================
+ Coverage   71.85%   72.18%   +0.33%     
==========================================
  Files         134      134              
  Lines        7340     7449     +109     
  Branches     1563     1527      -36     
==========================================
+ Hits         5274     5377     +103     
- Misses       2020     2026       +6     
  Partials       46       46              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

## AI Skills

Skills are designed to improve AI agent performance by providing structured instructions and resources for specific tasks. This is applicable to any AI agent with skill support, and developers can point AI agents to the skills directory for structured task handling.
Skills are designed to improve AI agent performance by providing structured instructions and resources for specific tasks. Skills are best used in conjunction with tools that support skill use, though agents can be manually directed to use the skills as well.
Copy link
Contributor

Choose a reason for hiding this comment

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

should we also cautious against using skills downloaded online blindly without auditing it due to security concerns?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh you mean like those you just download online without adding to the repo first?

Hmm, I feel like that's quite a given but maybe it'd be good to say that quiet part out loud ah (i.e. don't be stupid lol).

Maybe something like:

Do not use Skills found online without auditing them first. It is also strongly recommended to create a separate pull request to review the Skill before proper use.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yep u right

@Harjun751 Harjun751 requested a review from a team February 4, 2026 09:15
Copy link
Contributor

@yihao03 yihao03 left a comment

Choose a reason for hiding this comment

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

LGTM! Why is vibecoding hard now

Skills are located in the `.github/skills/` directory. You can point AI agents to this directory to leverage the structured instructions and resources provided by the skills.
### Setting up Skills

Skills are located in the `.github/skills/` directory. Many tools and agents require different directory structures to enable skill use. It is suggested to set up symlinks for the specific directory structure required.
Copy link
Contributor

Choose a reason for hiding this comment

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

I understand that you have added some popular ai directories to the .gitignore. Do you think we can also mention that whoever using some other ai agents or repositories should also populate the .gitignore accordingly?

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