diff --git a/docs/devins/devins-language.md b/docs/devins/devins-language.md index f9cda654a1..a42734512d 100644 --- a/docs/devins/devins-language.md +++ b/docs/devins/devins-language.md @@ -27,7 +27,7 @@ Based on: [JetBrains' Markdown Util](https://github.com/JetBrains/intellij-commu ## Language spec ```bnf -DevInsFile ::= (used | code | TEXT_SEGMENT | NEWLINE)* +DevInFile ::= (used | code | TEXT_SEGMENT | NEWLINE)* used ::= ( AGENT_START AGENT_ID @@ -45,19 +45,28 @@ code_contents ::= (NEWLINE | CODE_CONTENT)* ### Introduce file +For example: + ```devin Explain code /file:src/main/java/com/example/Controller.java ``` +will call LLM to explain the code in the file `src/main/java/com/example/Controller.java`. + ### Edit file -```devin -/edit /file:src/main/java/com/example/Controller.java#L1-L12 -\`\`\`java -public class Controller { - public void method() { - System.out.println("Hello, World!"); +If AI Agent returns a code snippet, AutoDev can edit the file with the code snippet. + +For example: + + /edit /file:src/main/java/com/example/Controller.java#L1-L12 + ```java + public class Controller { + public void method() { + System.out.println("Hello, World!"); + } } -} -\`\`\` -``` + ``` + +will edit the file `src/main/java/com/example/Controller.java` with the code snippet. +The `#L1-L12` is the line range to edit. The code snippet is in Java language. diff --git a/docs/devins/devins.md b/docs/devins/devins.md index a7f0f7c740..16c75df856 100644 --- a/docs/devins/devins.md +++ b/docs/devins/devins.md @@ -8,9 +8,13 @@ permalink: /devins {: .no_toc } -# DevIn Language +# DevIns Language -DevIn lang is the AutoDev AI Agent language, which means Development Intelligence. -DevIn can make the AI Agent more intelligent and more powerful. It is a language that can be used to describe +DevIns lang is the AutoDev AI Agent language, which means Development Intelligence. +DevIns can make the AI Agent more intelligent and more powerful. It is a language that can be used to describe the AI Agent's behavior and capabilities. +An AI Agent task can split into multiple instructions, and each instruction can be description by a DevIn file, +which is a markdown file with DevIn language. + + diff --git a/exts/devins-lang/README.md b/exts/devins-lang/README.md index e25b479cb3..72e10eed9a 100644 --- a/exts/devins-lang/README.md +++ b/exts/devins-lang/README.md @@ -1,8 +1,26 @@ -# DevIns Language +# DevIns Lang: Enhancing AI Agent Capabilities -> DevIn lang is the AutoDev AI Agent language, which means Development Intelligence. -> DevIn can make the AI Agent more intelligent and more powerful. It is a language that can be used to describe -> the AI Agent's behavior and capabilities. +DevIns Lang, short for Development Intelligence Language, is the driving force behind our AutoDev AI Agent's advanced +capabilities. It serves as a comprehensive tool for defining and enhancing the behavior and functionalities of the AI +Agent. +## What is DevIns? +DevIns Lang empowers developers to craft intricate instructions for the AI Agent, enabling it to perform tasks with +greater intelligence and efficiency. By breaking down tasks into manageable instructions, developers can leverage the +full potential of the AI Agent in various scenarios. + +### Key Features: + +- **Enhanced Intelligence**: DevIns Lang equips the AI Agent with a higher level of intelligence, enabling it to + understand and execute complex instructions effectively. +- **Task Segmentation**: Complex AI tasks are divided into smaller, more manageable instructions, each defined using + DevIns language within markdown files. + +### Why DevIns? + +Originally named DevInputLanguage in Issue [#101](https://github.com/unit-mesh/auto-dev/issues/101) for better +interaction with LLM, we later renamed it to DevIns. This change was prompted by the discovery of Devin AI, a renowned +AI company, to avoid confusion. The name DevIns, derived from DevInstruction, succinctly captures the essence of the +language in guiding the AI Agent's actions.