check in

Author: Howon Lee

docs/guides/agent_chat.md

@@ -0,0 +1,92 @@
+# CodeRabbit Agentic Chat
+
+CodeRabbit Chat is a powerful assistant designed to streamline your development workflow. You can talk to CodeRabbit directly in pull request review comments and pull request comments to ask questions, have CodeRabbit rewrite code and write new code.
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+- [Invocation](#invocation)
+- [Features](#features)
+  - [Script Writing](#script-writing)
+  - [Web Search](#web-search)
+  - [Jira and Linear Integration](#jira-and-linear-integration)
+  - [Learnings Integration](#learnings-integration)
+  - [Single Step Code Generation](#single-step-code-generation)
+  - [Multi-Step Agentic Flow with Planning](#multi-step-agentic-flow-with-planning)
+  - [Configuration Changes](#configuration-changes)
+- [Usage Guidelines](#usage-guidelines)
+- [Support and Contributions](#support-and-contributions)
+
+## Getting Started
+
+Agentic chat is available only for Pro customers. //// some crap about contacting sales paying us money
+
+## Invocation
+
+To invoke the CodeRabbit agentic chat, simply comment on a pull request with:
+
+@coderabbitai
+
+without an explicit command in ordinary natural language. Once invoked, CodeRabbit will process your request and respond with the necessary assistance. This can involve script generation, issue tracking updates, detailed code suggestions, or an entire stacked pull request. /// link to command
+
+## Features
+
+### Script Writing
+
+- **Automated Script Generation:** CodeRabbit can write shell scripts and scripts in other languages when necessary.
+- **Adaptive Scripting:** The agent decides on the most appropriate scripting language and structure based on your query.
+- **Efficiency:** Reduces manual coding effort by automating repetitive or standard scripting tasks.
+
+### Web Search
+
+- **Real-Time Information:** Integrates web search capabilities to fetch up-to-date information that can be used to answer your questions.
+- **Contextual Assistance:** Leverages current data to provide more accurate and informed responses.
+- **Improved Decision Making:** Helps in validating assumptions or learning new methodologies by providing relevant external resources.
+
+### Jira and Linear Integration
+
+- **Seamless Issue Tracking:** Connects with Jira and Linear, allowing you to manage issues directly from your development environment.
+- **Project Management:** Facilitates streamlined task updates and status changes, ensuring that your project’s workflow remains uninterrupted.
+- **Automated Workflows:** Reduces the need for manual entry by synchronizing pull request comments and code updates with your project management tools.
+
+### Learnings Integration
+
+- **Dynamic Learning:** Incorporates learnings and best practices into its workflows.
+- **Memory Functionality:** Simply instruct the agent to remember a piece of information, and it will integrate it into future tasks.
+- **Continuous Improvement:** Uses accumulated learnings to refine code quality and improve overall efficiency.
+
+### Single Step Code Generation
+
+- **Rapid Prototyping:** Generates code snippets in a single step, ideal for quick copy-and-paste tasks.
+- **Error Reduction:** Automates repetitive code tasks, reducing the risk of human error.
+- **Time Saving:** Streamlines the development process by delivering immediate code solutions.
+
+### Multi-Step Agentic Flow with Planning
+
+- **Complex Workflow Support:** Handles multi-step tasks that require detailed planning and execution.
+- **Sophisticated Code Generation:** Uses advanced planning strategies to solve intricate coding challenges.
+- **Automated Pull Requests:** Can issue a pull request for code changes once the multi-step workflow is complete.
+- **Iterative Improvement:** Provides a structured approach to refine code over several iterations.
+
+### Configuration Changes
+
+- **Self-Managed Configurations:** The CodeRabbit agent can manage its own configuration settings upon request.
+- **Dynamic Adaptation:** Allows for configuration updates that cater to changing project needs.
+- **Ease of Use:** Simplifies the process of adapting the agent to new workflows or requirements.
+
+## Usage Guidelines
+
+- **Keep Instructions Clear:** When invoking CodeRabbit, be explicit about your requirements to ensure accurate and relevant responses.
+- **Leverage the Integration:** Make full use of the integrated tools like Jira, Linear, and web search for a seamless workflow.
+- **Feedback Loop:** If a generated solution does not meet your expectations, provide feedback so that the agent can refine its output.
+- **Security Practices:** Ensure that sensitive information is not shared inadvertently during agent invocation.
+
+## Support and Contributions
+
+For additional support, bug reports, or to contribute to the development of CodeRabbit Agentic Chat, please refer to the project repository and its contribution guidelines. Engaging with the community will help improve the agent and its features continuously.
+
+---
+
+By integrating these robust features, CodeRabbit Agentic Chat enhances your coding workflow, making it a valuable tool for both individual developers and larger teams. Enjoy a more efficient and streamlined development process with CodeRabbit!
+
+