Skip to content

Add skills setup info to docs #2823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Harjun751 wants to merge 4 commits into from
+17 −5
Closed

Add skills setup info to docs #2823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b8bf36
Add AI-tool-specific exclusions to .gitignore
Harjun751 Feb 2, 2026
ef98cfe
Update AI use guide on setting up skills properly
Harjun751 Feb 2, 2026
3e4c3e5
Update skill set up instruction
Harjun751 Feb 3, 2026
ce3b3a1
Add warning on skill use in dev docs
Harjun751 Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,9 @@ packages/core/src/lib/progress/*.js

# Nx for Lerna
.nx/cache
.nx/workspace-data
.nx/workspace-data

# AI tool-specific configuration
.opencode
.claude
.cline
15 changes: 11 additions & 4 deletions docs/devGuide/development/aiUse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,18 @@ The MarkBind project has configurations that facilitate AI use.

## 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

@yihao03 yihao03 Feb 2, 2026

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

@Harjun751 Harjun751 Feb 3, 2026

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

@yihao03 yihao03 Feb 3, 2026

Choose a reason for hiding this comment

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

Yep u right


### Skills Directory
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.

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

@yihao03 yihao03 Feb 4, 2026

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?


For example, if configuring opencode:
```
ln -s .github/ .opencode
```

### List of Skills

Expand All @@ -39,7 +46,7 @@ If you find yourself performing similar structured tasks with an AI agent, consi

### Using Skills

Skills relevant to particular tasks should be invoked automatically by AI agents. You may opt to directly point the agent to a skill.
Skills relevant to particular tasks should be invoked automatically by AI agents.

### Useful Links
- [Skill.sh skill repository](https://skills.sh/)
Expand Down