Merge pull request #8 from preeesha/fix--documentation

Enhanced Documentation Across Components and Commands

Author: CulturalProfessor

README.md

@@ -18,8 +18,6 @@ Rocket Chatter App is an open-source AI-powered assistant designed to help devel
 
 - **Assess Code Importance**: The app can evaluate the criticality and centrality of code entities, providing insights into their impact and dependencies, which is crucial for tasks like refactoring or introducing new features. The app will generate scores for criticality (how many other parts of the code depend on this entity), centrality (how connected this entity is to other parts), and overall importance, helping developers prioritize their efforts.
 
-- **Enforce Style Guides**: The app can automatically check the codebase against predefined style guides and coding standards, ensuring code quality, consistency, and readability across the project. Developers can provide code snippets, and the app will suggest improvements based on the project's style guide, promoting best practices and maintainability.
-
 - **Suggest Improvements**: The app can analyze code snippets and offer targeted refactoring suggestions, such as renaming variables, extracting code into reusable functions, removing dead code, and optimizing performance. These suggestions will help developers write cleaner, more efficient, and maintainable code while adhering to the project's coding standards.
 
 ### Accessibility and Collaboration
@@ -49,21 +47,19 @@ Rocket Chatter App is an open-source AI-powered assistant designed to help devel
 
 ### Usage
 
-Once the application is running, you can access the Rocket Chatter App through the Rocket.Chat interface. The app provides various slash commands (e.g., `/rcc-ask`, `/rcc-diagram`, `/rcc-document`) that you can use to interact with the assistant.
+Once the application is running, you can access the Rocket Chatter App through the Rocket.Chat interface. The app provides various slash commands (e.g., `/rcc-askcode`, `/rcc-diagram`, `/rcc-document`) that you can use to interact with the assistant.
 
 ## Architecture
 
 The Rocket Chatter App follows a modular architecture with the following main components:
 
 1. **Rocket Chat Application**: A user-friendly interface for developers to interact with the system, enabling them to ask questions, request diagrams, and access documentation directly within the Rocket.Chat environment. The application is built using the Rocket.Chat App Engine SDK and is deployed as a Rocket.Chat App. ![Rocket Chatter App](./docs/images/architecture-rc-app.png)
 2. **Ingestion Server**: Responsible for parsing the Rocket.Chat codebase, extracting relevant information, and storing it in the Neo4j graph database. It utilizes compiler APIs like `ts-morph` and `jscodeshift` to handle TypeScript and JavaScript code constructs. The ingestion process involves chunking the codebase, generating embeddings for code entities, and establishing relationships between them in the graph database. ![Rocket Chatter App](./docs/images/architecture-ingestion-server.png)
-3. **Application Server**: A middleware component built with Express.js that serves as a bridge between the database and the client application. It handles requests from the Rocket Chat App, queries the Neo4j database using cosine similarity-based searches, and generates responses using Language Models (LMs). The server employs a Retrieval Augmented Generation (RAG) pipeline to provide contextual and accurate information to developers. ![Rocket Chatter App](./docs/images/architecture-application-server.png)
-
 
 ### Development Environment Setup
 
-1. Fork the repository and clone your fork: `git clone https://github.com/your-username/rocket-chatter-app.git`
-2. Navigate to the project directory: `cd rocket-chatter-app`
-3. Install dependencies: `npm install`
+1. Fork the repository and clone your fork: `git clone https://github.com/your-username/Apps.AI.Codebase.Assistant.git`
+2. Navigate to the project directory: `cd Apps.AI.Codebase.Assistant`
+3. Install dependencies: `bun install`
 4. Set up the required environment variables (e.g., database credentials, API keys) by creating a `.env` file based on the provided `.env.example` file.
 5. Start the development server: `npm run dev`

ai-assistant/README.md

@@ -1,22 +1,99 @@
 # AI Assistant
-AI Assistant
-
-## Getting Started
-Now that you have generated a blank default Rocket.Chat App, what are you supposed to do next?
-Start developing! Open up your favorite editor, our recommended one is Visual Studio code,
-and start working on your App. Once you have something ready to test, you can either
-package it up and manually deploy it to your test instance or you can use the CLI to do so.
-Here are some commands to get started:
-- `rc-apps package`: this command will generate a packaged app file (zip) which can be installed **if** it compiles with TypeScript
-- `rc-apps deploy`: this will do what `package` does but will then ask you for your server url, username, and password to deploy it for you
-
-## Documentation
-Here are some links to examples and documentation:
-- [Rocket.Chat Apps TypeScript Definitions Documentation](https://rocketchat.github.io/Rocket.Chat.Apps-engine/)
-- [Rocket.Chat Apps TypeScript Definitions Repository](https://github.com/RocketChat/Rocket.Chat.Apps-engine)
-- [Example Rocket.Chat Apps](https://github.com/graywolf336/RocketChatApps)
-- Community Forums
-  - [App Requests](https://forums.rocket.chat/c/rocket-chat-apps/requests)
-  - [App Guides](https://forums.rocket.chat/c/rocket-chat-apps/guides)
-  - [Top View of Both Categories](https://forums.rocket.chat/c/rocket-chat-apps)
-- [#rocketchat-apps on Open.Rocket.Chat](https://open.rocket.chat/channel/rocketchat-apps)
+
+Rocket Chatter is a Rocket.Chat bot that provides code-related information and assistance to developers working on the Rocket Chat project. The bot is designed to help developers understand the Rocket Chat codebase, find relevant documentation, and improve their coding practices. Rocket Chatter uses the Rocket Chat API to access the codebase and provide context-specific information and suggestions to users.
+
+## Commands
+
+### `/rcc-help`
+
+Provides descriptions and usage instructions for all available Rocket Chatter commands.
+
+```
+/rcc-help
+```
+
+### `/rcc-askcode`
+
+Allows users to ask specific code-related questions about the Rocket Chat's codebase and receive context-specific answers.
+
+```
+/rcc-askcode [your query]
+```
+
+### `/rcc-askdocs`
+
+Accesses and provides developer documentation related to the Rocket Chat project, including setup guides, API references, and contribution guidelines.
+
+```
+/rcc-askdocs [your query]
+```
+
+### `/rcc-diagram`
+
+Generates clarifying diagrams to visually represent the relationships and structures between an entity and it's dependencies within the Rocket Chat codebase.
+
+```
+/rcc-diagram [entity]
+```
+
+### `/rcc-document`
+
+Generates the documentation for a specific entity within the Rocket Chat codebase.
+
+```
+/rcc-document [entity]
+```
+
+### `/rcc-findsimilar`
+
+Finds similar entities to the one provided within the Rocket Chat codebase to reduce redundancy and improve code quality.
+
+```
+/rcc-findsimilar
+```
+
+(A modal will open to input the code snippet you want to find similar entities to)
+
+### `/rcc-improve`
+
+Offers suggestions for code improvements, refactoring, or enhancements based on best practices and project standards.
+
+```
+/rcc-improve
+```
+
+(A modal will open to input the code snippet you want to suggest improvements for)
+
+### `/rcc-importance`
+
+Determines and explains the importance of a specific code entity within the larger context of the Rocket Chat codebase.
+
+```
+/rcc-importance [entity]
+```
+
+### `/rcc-testcases`
+
+Generates test cases for the provided code which uses Rocket Chat codebase to ensure proper functionality and test coverage.
+
+```
+/rcc-testcases
+```
+
+(A modal will open to input the code snippet you want to generate testcases for)
+
+### `/rcc-translate`
+
+Translates the target entity from one programming language to another for a better understanding of the codebase.
+
+```
+/rcc-translate [entity] [target language]
+```
+
+### `/rcc-whyused`
+
+Explains why a specific entity is used within the Rocket Chat codebase.
+
+```
+/rcc-whyused [entity]
+```

ai-assistant/src/commands/AskCodeCommand.ts

@@ -21,6 +21,13 @@ export class AskCodeCommand implements ISlashCommand {
     public i18nDescription = "";
     public providesPreview = false;
 
+    /**
+     * Processes the user's query and returns the answer.
+     *
+     * @param {IHttp} http - The HTTP object used for making requests.
+     * @param {string} query - The user's query.
+     * @returns {Promise<string | null>} A promise that resolves to the response to be given to the user or `null` if no answer or no reference is found.
+     */
     private async process(http: IHttp, query: string): Promise<string | null> {
         const db = new Neo4j(http);
         const llm = new Llama3_70B(http);
@@ -65,6 +72,15 @@ export class AskCodeCommand implements ISlashCommand {
         return answer;
     }
 
+    /**
+     * Executes the AskCodeCommand.
+     *
+     * @param context - The SlashCommandContext object.
+     * @param read - The IRead object.
+     * @param modify - The IModify object.
+     * @param http - The IHttp object.
+     * @returns A Promise that resolves to void.
+     */
     public async executor(
         context: SlashCommandContext,
         read: IRead,

ai-assistant/src/commands/DocumentCommand.ts

@@ -20,6 +20,13 @@ export class DocumentCommand implements ISlashCommand {
     public i18nDescription = "";
     public providesPreview = false;
 
+    /**
+     * Processes the HTTP request and query to generate documentation.
+     *
+     * @param http - The HTTP client.
+     * @param query - The user's query.
+     * @returns A promise that resolves to an object containing the generated JSDoc and explanation, or null if no references are found or the documentation could be generated.
+     */
     private async process(
         http: IHttp,
         query: string
@@ -78,6 +85,15 @@ export class DocumentCommand implements ISlashCommand {
         };
     }
 
+    /**
+     * Executes the command to retrieve and display documentation for a given query.
+     *
+     * @param context - The SlashCommandContext object containing information about the command execution.
+     * @param read - The IRead object used to read data from the Rocket.Chat server.
+     * @param modify - The IModify object used to modify data on the Rocket.Chat server.
+     * @param http - The IHttp object used to make HTTP requests.
+     * @returns A Promise that resolves to void.
+     */
     public async executor(
         context: SlashCommandContext,
         read: IRead,

ai-assistant/src/commands/FindSimilar.modal.ts

@@ -20,6 +20,11 @@ import { handleCommandResponse } from "../utils/handleCommandResponse";
 export const COMMAND = "rcc-findsimilar";
 export const FIND_SIMILAR_COMMAND_MODAL = "findsimilar-command";
 
+/**
+ * Helps to build the modal for `/rcc-findsimilar` command.
+ *
+ * @returns A promise that resolves to an object of type IUIKitSurfaceViewParam used to open RC's modal.
+ */
 export async function findSimilarModal(): Promise<IUIKitSurfaceViewParam> {
     return {
         id: FIND_SIMILAR_COMMAND_MODAL,
@@ -44,6 +49,13 @@ export async function findSimilarModal(): Promise<IUIKitSurfaceViewParam> {
     };
 }
 
+/**
+ * Processes the given query to find similar nodes in the database.
+ *
+ * @param http - The IHttp instance used for making HTTP requests.
+ * @param query - The user's query string to process.
+ * @returns Related code chunks from the database.
+ */
 async function process(http: IHttp, query: string): Promise<DBNode[] | null> {
     const db = new Neo4j(http);
     const embeddingModel = new MiniLML6(http);
@@ -61,6 +73,16 @@ async function process(http: IHttp, query: string): Promise<DBNode[] | null> {
     return similarNodes;
 }
 
+/**
+ * Handles the submit event of the findSimilarModal.
+ *
+ * @param view - The UI kit surface view.
+ * @param sender - The user who triggered the event.
+ * @param room - The room where the event occurred.
+ * @param read - The read utility.
+ * @param modify - The modify utility.
+ * @param http - The HTTP utility.
+ */
 export async function findSimilarModalSubmitHandler(
     view: IUIKitSurface,
     sender: IUser,

ai-assistant/src/commands/FindSimilar.ts

@@ -17,6 +17,17 @@ export class FindSimilarCommand implements ISlashCommand {
     public i18nDescription = "";
     public providesPreview = false;
 
+    /**
+     * Executes the FindSimilar command.
+     * 
+     * @param context - The SlashCommandContext object.
+     * @param read - The IRead object.
+     * @param modify - The IModify object.
+     * @param http - The IHttp object.
+     * @param persistence - The IPersistence object.
+     * @returns A Promise that resolves to void.
+     * @throws Error if no trigger ID is provided.
+     */
     public async executor(
         context: SlashCommandContext,
         read: IRead,

ai-assistant/src/commands/HelpCommand.ts

@@ -13,16 +13,23 @@ import { handleCommandResponse } from "../utils/handleCommandResponse";
 const HELP_MESSAGE = `
 ## Rocket Chatter
 
-Rocket Chatter is a Slack bot that provides code-related information and assistance to developers working on the Rocket Chat project. The bot is designed to help developers understand the Rocket Chat codebase, find relevant documentation, and improve their coding practices. Rocket Chatter uses the Rocket Chat API to access the codebase and provide context-specific information and suggestions to users.
+Rocket Chatter is a Rocket.Chat bot that provides code-related information and assistance to developers working on the Rocket Chat project. The bot is designed to help developers understand the Rocket Chat codebase, find relevant documentation, and improve their coding practices. Rocket Chatter uses the Rocket Chat API to access the codebase and provide context-specific information and suggestions to users.
 
 \`/rcc-help\`: Provides descriptions and usage instructions for all available Rocket Chatter commands.
 \`\`\`
 /rcc-help
 \`\`\`
-\`/rcc-ask\`: Allows users to ask specific code-related questions about the Rocket Chat's codebase and receive context-specific answers.
+
+\`/rcc-askcode\`: Allows users to ask specific code-related questions about the Rocket Chat's codebase and receive context-specific answers.
+\`\`\`
+/rcc-askcode [your query]
+\`\`\`
+
+\`/rcc-askdocs\`: Accesses and provides developer documentation related to the Rocket Chat project, including setup guides, API references, and contribution guidelines.
 \`\`\`
-/rcc-ask [your query]
+/rcc-askdocs [topic]
 \`\`\`
+
 \`/rcc-diagram\`: Generates clarifying diagrams to visually represent the relationships and structures between an entity and it's dependencies within the Rocket Chat codebase.
 \`\`\`
 /rcc-diagram [entity]
@@ -39,18 +46,12 @@ Rocket Chatter is a Slack bot that provides code-related information and assista
 \`\`\`
 (A modal will open to input the code snippet you want to find similar entities to)
 
-\`/rcc-suggest\`: Offers suggestions for code improvements, refactoring, or enhancements based on best practices and project standards.
+\`/rcc-improve\`: Offers suggestions for code improvements, refactoring, or enhancements based on best practices and project standards.
 \`\`\`
-/rcc-suggest
+/rcc-improve
 \`\`\`
 (A modal will open to input the code snippet you want to suggest improvements for)
 
-\`/rcc-styleguide\`: Formats the codebase according to the styleguide used throughout the codebase.
-\`\`\`
-/rcc-styleguide
-\`\`\`
-(A modal will open to input the code snippet you want to format)
-
 \`/rcc-importance\`: Determines and explains the importance of a specific code entity within the larger context of the Rocket Chat codebase.
 \`\`\`
 /rcc-importance [entity]
@@ -71,11 +72,6 @@ Rocket Chatter is a Slack bot that provides code-related information and assista
 \`\`\`
 /rcc-whyused [entity]
 \`\`\`
-
-\`/rcc-devdocs\`: Accesses and provides developer documentation related to the Rocket Chat project, including setup guides, API references, and contribution guidelines.
-\`\`\`
-/rcc-devdocs [topic]
-\`\`\`
 `;
 
 export class HelpCommand implements ISlashCommand {