docs: clarify curated skills repo
This commit is contained in:
parent
714f23840b
commit
a8b3c261fc
@ -42,6 +42,19 @@ To keep skills consistent across teams, use a central skills registry plus a per
|
|||||||
- Sync script that pulls the approved set to each developer's laptop
|
- Sync script that pulls the approved set to each developer's laptop
|
||||||
- Agents.md points to the manifest and sync command
|
- Agents.md points to the manifest and sync command
|
||||||
|
|
||||||
|
### Proposed Curated Repo Structure
|
||||||
|
Keep the approved list in a single repo and organize by platform:
|
||||||
|
|
||||||
|
```text
|
||||||
|
repo-root/
|
||||||
|
ios-skills.yaml
|
||||||
|
android-skills.yaml
|
||||||
|
shared-skills.yaml
|
||||||
|
agents/
|
||||||
|
instructions/
|
||||||
|
README.md
|
||||||
|
```
|
||||||
|
|
||||||
### Project Manifest Example
|
### Project Manifest Example
|
||||||
Use a small manifest to declare the approved skills and versions for the project:
|
Use a small manifest to declare the approved skills and versions for the project:
|
||||||
|
|
||||||
@ -68,6 +81,8 @@ skills:
|
|||||||
## skills.sh (Optional Skills Installer)
|
## skills.sh (Optional Skills Installer)
|
||||||
skills.sh provides a public skills catalog and a CLI to install skills by name. Use this only if your team allows it and you understand the source of the skills you install.
|
skills.sh provides a public skills catalog and a CLI to install skills by name. Use this only if your team allows it and you understand the source of the skills you install.
|
||||||
|
|
||||||
|
If you have a curated repo, treat skills.sh as a discovery tool only. The source of truth should remain your curated lists.
|
||||||
|
|
||||||
### Where To Find Skills
|
### Where To Find Skills
|
||||||
- Homepage: https://skills.sh/
|
- Homepage: https://skills.sh/
|
||||||
- Docs: https://skills.sh/docs
|
- Docs: https://skills.sh/docs
|
||||||
@ -108,11 +123,25 @@ npx skills remove Remove installed skills
|
|||||||
npx skills init [name] Create a new skill
|
npx skills init [name] Create a new skill
|
||||||
```
|
```
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## How to Download Existing Skills
|
## How to Download Existing Skills
|
||||||
1. Locate the skill in the team or org repository.
|
1. Locate the skill in the team or org repository.
|
||||||
2. Add the skill to your local skills directory following team guidance.
|
2. Add the skill to your local skills directory following team guidance.
|
||||||
3. Restart the editor or chat if required so the skill is recognized.
|
3. Restart the editor or chat if required so the skill is recognized.
|
||||||
|
|
||||||
|
## How to Download Agents
|
||||||
|
Agents are distributed in the curated repo under an agents folder. A simple approach is to clone the repo and copy the agents into your user-level agents directory.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
```bash
|
||||||
|
git clone git@<host>:org/ai-assets.git
|
||||||
|
mkdir -p ~/.agents/agents
|
||||||
|
cp -R ai-assets/agents/* ~/.agents/agents/
|
||||||
|
```
|
||||||
|
|
||||||
|
If your team provides a sync script, use that instead of manual copy.
|
||||||
|
|
||||||
## How to Enable or Configure Skills
|
## How to Enable or Configure Skills
|
||||||
- Follow the instructions provided in each skill's README or SKILL file.
|
- Follow the instructions provided in each skill's README or SKILL file.
|
||||||
- Some skills require additional setup, such as environment variables or tools.
|
- Some skills require additional setup, such as environment variables or tools.
|
||||||
@ -136,6 +165,7 @@ Do not list every skill in this guide. Instead, point readers to a single repo t
|
|||||||
- Skills (SKILL files and any required setup)
|
- Skills (SKILL files and any required setup)
|
||||||
- Instructions (repo-level and editor-level guidance)
|
- Instructions (repo-level and editor-level guidance)
|
||||||
- A short README with install and update steps
|
- A short README with install and update steps
|
||||||
|
- Curated skill lists (for example, ios-skills.yaml, android-skills.yaml)
|
||||||
|
|
||||||
### Link To The Assets Repo
|
### Link To The Assets Repo
|
||||||
- Repo: (link)
|
- Repo: (link)
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user