Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.6 KB

user_guide.md

File metadata and controls

47 lines (30 loc) · 1.6 KB

docs/user_guide.md

This document serves as a manual for using the InsightCode tool.

# User Guide

## Overview

InsightCode is an AI-powered code review assistant designed to improve code quality through static analysis and natural language feedback.

## Accessing the Dashboard

1. **Open the Application**
   Navigate to `http://localhost:3000` to access the frontend dashboard.

2. **Login**
   Use the credentials provided by your administrator to log in.

3. **Dashboard Overview**
   - **Code Review Summaries**: View a summary of recent code reviews.
   - **Review List**: Access detailed information about individual reviews.
   - **Feedback**: See human-like feedback generated by the NLP model.

## Using the Code Review Feature

1. **View Pull Requests**
   Select a pull request from the list to view its details.

2. **Review Feedback**
   Read through the feedback provided for each code section. The feedback includes suggestions for improvement and identified issues.

3. **Respond to Feedback**
   You can respond to feedback directly within the interface. Comments and suggestions can be addressed before finalizing the review.

## Admin Features

1. **Configure Settings**
   Navigate to the settings page to adjust configuration parameters, including API keys and integration settings.

2. **Manage Users**
   Admins can manage user accounts and permissions through the user management interface.

3. **Integrations**
   Set up and configure integrations with GitHub and CI/CD pipelines through the admin settings.

For detailed instructions on setting up integrations, refer to the `setup_guide.md`.