diff --git a/_articles/ai/agent-skills.md b/_articles/ai/agent-skills.md new file mode 100644 index 00000000..178643a8 --- /dev/null +++ b/_articles/ai/agent-skills.md @@ -0,0 +1,35 @@ +--- +layout: default-layout +needAutoGenerateSidebar: true +noTitleIndex: true +title: Agent Skills | Dynamic Web TWAIN Documentation +keywords: Dynamic Web TWAIN, Documentation, Agent Skills +breadcrumbText: Agent Skills +description: This post teaches you how to use Dynamic Web TWAIN's official agent skills. +--- + +# Agent Skills + +Agent Skills are structured instruction files that teach AI agents how to use Dynamic Web TWAIN in your web apps accurately and efficiently. They work with Claude Code, Cursor, Codex, and other AI agents. + +You can run the following command to install the skills: + +```bash +npx skills add https://github.com/Dynamsoft/web-twain-samples/ +``` + +## Example Prompts + +Try the following prompts after installing. Your AI agent will automatically use the installed skills: + +| Prompt | Description | +|--------|-------------| +| Please create a component to use Dynamic Web TWAIN for document scanning in this angular app. Just a scan button to perform scanning and view the document in a viewer. | Use Web TWAIN in an existing Angular project. | +| Please write an html file which loads Web TWAIN via CDN. The page contains a scan button, which triggers scanning with the scanner ui. The scanned images are displayed in Web TWAIN's viewer. | Create a plain JavaScript HTML file to scan documents. | +| What is Dynamic Web TWAIN service? | Ask questions about Web TWAIN. | + + +## Additional Resources + +* [GitHub repo](https://github.com/Dynamsoft/web-twain-samples/tree/main/skills) +* [Agent Skills documentation](https://agentskills.io/home) diff --git a/_articles/ai/overview.md b/_articles/ai/overview.md new file mode 100644 index 00000000..06981123 --- /dev/null +++ b/_articles/ai/overview.md @@ -0,0 +1,23 @@ +--- +layout: default-layout +needAutoGenerateSidebar: true +noTitleIndex: true +title: AI Overview | Dynamic Web TWAIN Documentation +keywords: Dynamic Web TWAIN, TWAIN, AI, Documentation +breadcrumbText: AI Overview +description: Overview of Dynamic Web TWAIN and AI. +--- + +# AI Overview + +AI can answer questions related to Dynamic Web TWAIN and write codes directly. You can utilize AI in several ways. + +## How to Use + +1. Use the "Ask AI" buttton to ask questions about the SDK. + + ![Ask AI Button](/assets/imgs/ask-ai-button.jpg) + +2. Use the [agent skills](./agent-skills.md) in your AI agent like Claude Code, Codex and Cursor. Skills teach the agent how to include Web TWAIN in your project and use its APIs correctly. + +3. Use [llms.txt](/llms.txt) and [llms-full.txt](/llms-full.txt) to provide documentation for large language models (LLMs) and apps that use them. \ No newline at end of file diff --git a/_articles/index.md b/_articles/index.md index d7be4f7b..8a8e3d0b 100644 --- a/_articles/index.md +++ b/_articles/index.md @@ -94,6 +94,11 @@ description: Dynamic Web TWAIN SDK Documentation Homepage - [Addon]({{site.info}}schedule/Addon.html) - [Deprecated]({{site.info}}schedule/deprecated.html) +### AI + +- [Overview](/_articles/ai/overview.md) +- [Agent Skills](/_articles/ai/agent-skills.md) + ### [Upgrade Instructions]({{site.indepth}}development/upgrade.html) ### [End-User Guide](/_articles/end-user/index.md) ### [Resources]({{site.about}}resources.html) diff --git a/_data/full_tree.yml b/_data/full_tree.yml index ac2aaa62..0f8e2cb0 100644 --- a/_data/full_tree.yml +++ b/_data/full_tree.yml @@ -197,6 +197,12 @@ tree_list: path: /info/schedule/Addon.html - name: Deprecated path: /info/schedule/deprecated.html + - name: AI + childList: + - name: Overview + path: /ai/overview.html + - name: Agent Skills + path: /ai/agent-skills.html - name: Upgrade Instructions path: /indepth/development/upgrade.html - name: End-User Guide diff --git a/assets/imgs/ask-ai-button.jpg b/assets/imgs/ask-ai-button.jpg new file mode 100644 index 00000000..b6d47740 Binary files /dev/null and b/assets/imgs/ask-ai-button.jpg differ