diff --git a/.gitignore b/.gitignore index 354522f152..32ae0a3d42 100644 --- a/.gitignore +++ b/.gitignore @@ -109,4 +109,9 @@ packages/core/src/lib/progress/*.js # Nx for Lerna .nx/cache -.nx/workspace-data \ No newline at end of file +.nx/workspace-data + +# AI tool-specific configuration +.opencode +.claude +.cline diff --git a/docs/devGuide/development/aiUse.md b/docs/devGuide/development/aiUse.md index c89256645d..2627b8e50b 100644 --- a/docs/devGuide/development/aiUse.md +++ b/docs/devGuide/development/aiUse.md @@ -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. -### 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. + +For example, if configuring opencode: +``` +ln -s .github/ .opencode +``` ### List of Skills @@ -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/)