Merge pull request #6 from Codium-ai/add-installation-docs

Add installation docs
Codium-ai · Mar 15, 2024 · 0a792f9 · 0a792f9
2 parents 8597ce9 + cbccdaf
commit 0a792f9
Show file tree

Hide file tree

Showing 17 changed files with 95 additions and 57 deletions.
diff --git a/docs/chat/commands/ask.md b/docs/chat/commands/ask.md
@@ -14,7 +14,7 @@ To use the `/ask` command, follow these steps:
 
 3. **Initiate the Command**: Type `/ask` followed by your question in the chat interface. Codiumate will process your query and return a response tailored to the context of your selected mode and focus.
 
-4. **Continue the Chat**: If you require further assistance or have additional questions, click the "continue this chat" button. This action creates a [Thread](../threads.md), allowing for a more in-depth conversation regarding your query.
+4. **Continue the Chat**: If you require further assistance or have additional questions, click the "continue this chat" button. This action creates a [thread](../threads.md), allowing for a more in-depth conversation regarding your query.
 
 <h2>Available in</h2>
 - File Mode

diff --git a/docs/chat/commands/commit.md b/docs/chat/commands/commit.md
@@ -21,7 +21,8 @@ To utilize the `/commit` command effectively, follow these steps:
 
 <h2>Example</h2>
 
-<h3>Workspace Mode Example
+<h3>Workspace Mode Example</h3>
+
 **User**: Has staged several changes across multiple files, including bug fixes, feature additions, and documentation updates.
 
 **Command**: `/commit`

diff --git a/docs/chat/commands/describe.md b/docs/chat/commands/describe.md
@@ -1,9 +1,11 @@
 # `/describe`
 
 <h2>Description</h2>
+
 The `/describe` command in Codiumate is designed to streamline the process of preparing pull requests (PRs) and understanding changes within your workspace. By invoking this command with a focus on selected changes (local, staged, or committed), Codiumate generates a structured description of the changeset. This includes a title, type of changes (e.g., bug fix, feature addition, performance improvement), and a detailed description. This functionality is particularly useful for developers looking to summarize their work before opening a PR, ensuring that colleagues and contributors can quickly grasp the intent and scope of the changes.
 
 <h2>How to Use</h2>
+
 To utilize the `/describe` command effectively, follow these steps:
 
 1. **Select Your Changeset**: Identify the scope by selecting file, local, staged, or committed changes. 
@@ -15,12 +17,14 @@ To utilize the `/describe` command effectively, follow these steps:
 4. **Review and Use the Description**: Review the generated description for accuracy and completeness. You can then use this structured summary directly in your Git PR, facilitating clear communication and efficient collaboration with your team.
 
 <h2>Available in</h2>
+
 - Workspace Mode
 - File Changes Mode
 
 <h2>Example</h2>
 
 <h3>Workspace Mode Example</h3>
+
 **User**: Plans to open a PR for a series of changes that include bug fixes and a new feature.
 
 **Command**: `/describe`

diff --git a/docs/chat/commands/issues.md b/docs/chat/commands/issues.md
@@ -20,7 +20,7 @@ Follow these steps to efficiently utilize the `/issues` command:
 - Workspace Mode
 - File Changes Mode
 
-<h2>Example</h2>
+<!-- <h2>Example</h2>
 
 <h3>Workspace Mode Example</h3>
 **User**: Wants to ensure their project is free from security vulnerabilities and coding errors before deployment.
@@ -38,4 +38,4 @@ For each issue, Codiumate provides a direct link to the implicated code and a de
 
 **User Follow-Up**: Initiates a [thread](../threads.md) asking, "How can I secure the API keys?"
 
-**Codiumate Suggestion**: Offers strategies for securing API keys, such as environment variables or secure vault services, along with links to further reading.
+**Codiumate Suggestion**: Offers strategies for securing API keys, such as environment variables or secure vault services, along with links to further reading. -->
diff --git a/docs/chat/commands/quick-test.md b/docs/chat/commands/quick-test.md
@@ -1,7 +1,7 @@
 # `/quick-test`
 
 <h2>Description</h2>
-The `/quick-test` command initiates an iterative and interactive mode for generating test suites for your code. Unlike the comprehensive approach of the `/test-suite` command, `/quick-test` focuses on quickly producing a basic set of tests covering key behaviors. Users can fine-tune the generated tests through natural language chatting in a thread, allowing for precise customization until the desired test suite is achieved.
+The `/quick-test` command initiates an iterative and interactive mode for generating test suites for your code. Unlike the comprehensive approach of the `/test-suite` command, `/quick-test` focuses on quickly producing a basic set of tests covering key behaviors. Users can fine-tune the generated tests through natural language chatting in a [thread](../threads.md), allowing for precise customization until the desired test suite is achieved.
 
 <h2>How to Use</h2>
 To efficiently use the `/quick-test` command, follow these steps:
@@ -29,6 +29,6 @@ To efficiently use the `/quick-test` command, follow these steps:
 
 **Codiumate Response**: Codiumate produces an initial set of tests covering basic inputs, outputs, and functionality of the selected utility function.
 
-**User Interaction in Thread**: The developer specifies, "Add tests for edge cases and null inputs."
+**User Interaction in [Thread](../threads.md)**: The developer specifies, "Add tests for edge cases and null inputs."
 
 **Codiumate Update**: Codiumate iteratively refines the test suite, incorporating tests for edge cases and null inputs as requested.
diff --git a/docs/chat/commands/recap.md b/docs/chat/commands/recap.md
@@ -21,13 +21,13 @@ To effectively utilize the `/recap` command, adhere to the following steps:
 - Workspace Mode
 - File Changes Mode
 
-<h2>Example</h2>
+<!-- <h2>Example</h2>
 
 <h3>Workspace Mode Example</h3>
 **User**: Prepares to summarize recent work on a new feature for a team meeting.
 
 **Command**: `/recap`
 
-[TBD]
+[TBD] -->
 
 
diff --git a/docs/chat/commands/review.md b/docs/chat/commands/review.md
@@ -24,7 +24,7 @@ To make the most out of the `/review` command, follow these steps:
 - Workspace Mode
 - File Changes Mode
 
-<h2>Example</h2>
+<!-- <h2>Example</h2>
 
 <h3>Workspace Mode Example</h3>
 **User**: Prepares to submit a pull request including a new documentation file for a recently added command.
@@ -33,6 +33,6 @@ To make the most out of the `/review` command, follow these steps:
 
 **Codiumate Response**:
 
-[TBD]
+[TBD] -->
 
 
diff --git a/docs/chat/commands/update-changelog.md b/docs/chat/commands/update-changelog.md
@@ -18,7 +18,7 @@ Follow these steps to seamlessly update your changelog using the `/update-change
 - Workspace Mode
 - File Changes Mode
 
-<h2>Example</h2>
+<!-- <h2>Example</h2>
 
 <h3>Workspace Mode Example</h3>
 **User**: Needs to document recent enhancements and bug fixes in the project's changelog before a new release.
@@ -27,4 +27,4 @@ Follow these steps to seamlessly update your changelog using the `/update-change
 
 **Codiumate Response**: Generates a structured changelog entry, such as:
 
-[TBD]
+[TBD] -->
diff --git a/docs/chat/index.md b/docs/chat/index.md
@@ -1,4 +1,6 @@
-# Welcome to Codiumate Chat
+# Codiumate Chat
+
+## Overview 
 
 Welcome to Codiumate Chat, the integrated chat-based assistant designed to elevate your coding experience. Leveraging the power of advanced language models, Codiumate offers real-time coding assistance, documentation generation, code review, and more, all within your development environment. Whether you're a solo developer or part of a team, Codiumate streamlines your workflow, enhances code quality, and accelerates your project development.
 
@@ -14,7 +16,7 @@ To suit the context of your work, Codiumate offers three distinct modes:
 Each mode is designed to optimize Codiumate's assistance based on the scope of your coding tasks. [Discover more about modes](../modes/imdex.md).
 
 ### Commands
-Codiumate provides a suite of commands tailored to various coding needs, from generating docstrings and reviewing code to identifying issues and updating changelogs. Commands like `/ask`, `/explain`, `/commit`, and `/improve` are just the beginning of what Codiumate can do to support your coding journey. [Learn more about commands](./commands/index.md).
+Codiumate provides a suite of commands tailored to various coding needs, from generating docstrings and reviewing code to identifying issues and updating changelogs. Commands like [`/ask`](./commands/ask.md), [`/explain`](./commands/explain.md), [`/commit`](./commands/commit.md), and [`/improve`](./commands/improve.md) are just the beginning of what Codiumate can do to support your coding journey. [Learn more about commands](./commands/index.md).
 
 ### Threads
 Threads in Codiumate enable you to dive deeper into specific inquiries or commands. After an initial command execution, the "continue this chat" button allows for a threaded conversation, providing space for refinement, additional queries, and expanded discussions. This feature is invaluable for iterating on solutions, clarifying complex topics, and ensuring you get the most out of Codiumate's capabilities. [Explore threading](../threads.md).
diff --git a/docs/chat/modes/file-mode.md b/docs/chat/modes/file-mode.md
@@ -30,14 +30,14 @@ For File Mode option 3 (File Changes), you can use the workspace commands [Works
 
 1. **Access File Mode**: In the "Mode" drop-down, select File Mode to focus Codiumate on the current file.
 2. **Choose Your Focus**: Utilize the focus dropdown to select between Selected Lines, Selected Component, or File Changes based on your current requirement.
-3. **Execute a Command**: Type in your desired command (e.g., `/ask`, `/docstring`) followed by your question or request. Ensure your command matches the focus option you've selected for contextually relevant responses.
+3. **Execute a Command**: Type in your desired command (e.g., [`/ask`](../commands/ask.md), [`/docstring`](../commands/docstring.md)) followed by your question or request. Ensure your command matches the focus option you've selected for contextually relevant responses.
 4. **Switch Modes If Needed**: If your needs extend beyond the scope of the current file, you can switch to Workspace Mode or Free Chat Mode for broader or non-contextual assistance.
 
 ## Use Cases
 
-- **Code Understanding and Documentation**: Use `/explain` or `/docstring` for in-depth understanding and documentation of specific functions or classes.
-- **Code Quality Improvement**: Employ `/enhance` or `/improve` to refine your code with best practices, optimizations, and security enhancements.
-- **Test Suite Generation**: Leverage `/test-suite` or `/quick-test` for automated generation of test cases tailored to your selected code.
+- **Code Understanding and Documentation**: Use [`/explain`](../commands/explain.md) or [`/docstring`](../commands/docstring.md) for in-depth understanding and documentation of specific functions or classes.
+- **Code Quality Improvement**: Employ [`/enhance`](../commands/enhance.md) or [`/improve`](../commands/improve.md) to refine your code with best practices, optimizations, and security enhancements.
+- **Test Suite Generation**: Leverage [`/test-suite`](../commands/test-suite.md) or [`/quick-test`](../commands/quick-test.md) for automated generation of test cases tailored to your selected code.
 
 ## Add More Context
 

diff --git a/docs/chat/modes/workspace-mode.md b/docs/chat/modes/workspace-mode.md
@@ -33,6 +33,6 @@ The following commands are supported in Workspace Mode, offering a wide range of
 
 ## Use Cases
 
-- **Preparing for Commits**: Use `/commit` or `/describe` to craft meaningful commit messages and pull request descriptions.
-- **Code Quality Assurance**: Employ `/review`, `/improve`, and `/issues` to enhance the quality and security of your code before finalizing changes.
-- **Change Management**: Leverage `/recap` and `/update-changelog` to maintain comprehensive records of project evolution and ensure transparency.
+- **Preparing for Commits**: Use [`/commit`](../commands/commit.md) or [`/describe`](../commands/describe.md) to craft meaningful commit messages and pull request descriptions.
+- **Code Quality Assurance**: Employ [`/review`](../commands/review.md), [`/improve`](../commands/improve.md), and [`/issues`](../commands/issues.md) to enhance the quality and security of your code before finalizing changes.
+- **Change Management**: Leverage [`/recap`](../commands/recap.md) and [`/update-changelog`](../commands/update-changelog.md) to maintain comprehensive records of project evolution and ensure transparency.
diff --git a/docs/index.md b/docs/index.md
@@ -1,43 +1,46 @@
-# Overview
+# Welcome to Codiumate
 
-# Documatation portal is still WIP!
+### **Code, Test, and Review with Confidence - Your AI Mate by CodiumAI**
 
----
+Unlock the full potential of your coding process with Codiumate. Our integrated AI-powered tools offer iterative test generation, intelligent code assistance, and efficient pull request reviews, all designed to fit seamlessly into your development workflow.
 
-
-#### Code, test and review with confidence - your AI mate by CodiumAI
-
-Elevate your coding experience with iterative test generation, intelligent code assistant, and efficient PR reviewer, all smoothly integrated into your development workflow. 
-
-Boost your productivity, code with confidence, and optimize your development process!
+Elevate your productivity, code with unparalleled confidence, and streamline your development process like never before!
 
 ## Features
 
-- Generate unit tests suite automatically
+Codiumate comes packed with features to enhance every step of your development cycle:
 
-- Analyze your code
+- **[Iterative Test Generation](./tests/index.md)**: Automatically generate comprehensive test suites tailored to your codebase, ensuring high code quality and reliability.
+- **[Intelligent Code Assistance](./chat/modes/file-mode.md)**: Receive real-time suggestions and solutions for coding queries, documentation, debugging, and more.
+- **[Efficient PR Reviews](./chat/modes/workspace-mode.md)**: Simplify your pull request review process with AI-powered insights, highlighting potential issues and improvements.
 
-- Suggest code modifications to improve the performance and correctness of your code
+## Supported IDEs
 
-- Find potential bugs in your code and suggest ways to fix them
+Codiumate seamlessly integrates with your favorite IDEs:
 
-- Document and enhance your code automatically
+- **VSCode**: [Download from VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=Codium.codium)
+- **JetBrains IDEs**: [Download from JetBrains Plugins](https://plugins.jetbrains.com/plugin/21206-codiumate--code-test-and-review-with-confidence--by-codiumai)
 
-- Prepare better for your PR
+Ensure your IDE is set up to harness the full capabilities of Codiumate.
 
-- Help you improve code quality
+## Supported Languages
 
-## Supported IDEs
+Codiumate supports ALL programming languages for test generation, with enhanced support and features for:
 
-Codiumate is supported in [VSCode](https://marketplace.visualstudio.com/items?itemName=Codium.codium) and all [JetBrains IDEs](https://plugins.jetbrains.com/plugin/21206-codiumate--code-test-and-review-with-confidence--by-codiumai)
+- Python
+- JavaScript
+- TypeScript
+- Java
 
-## Supported Languages
+[Learn more about language support](./tests/supported-languages.md)
 
-Codiumate is supported in Python, Java, JavaScript, TypeScript, C++, C#, Go, PHP, Ruby, Rust, Scala, Swift and all other languages!
+## Bug Report
 
+Encountered an issue? Help us improve Codiumate by reporting bugs:
 
-## News
+- [Report a bug in VSCode](https://github.com/Codium-ai/codiumai-vscode-release/issues)
+- [Report a bug in JetBrains](https://github.com/Codium-ai/codiumai-jetbrains-release/issues)
 
-...
+Your feedback is invaluable in making Codiumate the best coding companion for developers worldwide.
 
-## Bug Report
+Welcome aboard, and let's code, test, and review with confidence!
diff --git a/docs/installation/index.md b/docs/installation/index.md
@@ -1,3 +1,31 @@
-# Installation
+# Installing Codiumate
 
-Coming Soon!
+Welcome to the first step in enhancing your development workflow with Codiumate. Follow this guide to download, install, and begin using Codiumate in your IDE.
+
+## Downloading Codiumate
+
+Codiumate is available for download from the marketplace for both VSCode and JetBrains (JB) IDEs. Select the link corresponding to your IDE to get started:
+
+- [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=Codium.codium)
+- [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/21206-codiumate--code-test-and-review-with-confidence--by-codiumai)
+
+## Logging into Codiumate
+
+Once the extension is installed, you'll need to log in to access Codiumate's features. You have several options for logging in, designed to suit your preferences and requirements:
+
+1. **Login with Google**: Quick access using your Google account.
+2. **Login with GitHub**: Utilize your GitHub account for an easy login experience.
+3. **Login with Email + Verification Code**: For those who prefer using their email, enter your email address, receive a verification code, and proceed with the login.
+
+### Enterprise Users
+
+If you're an Enterprise user, you should log in with your work email to be automatically associated with your enterprise account. If your organization has Single Sign-On (SSO) configured, you may also use this method for an even smoother login process.
+
+## Getting Started with Codiumate
+
+After successfully logging in, you're all set to explore Codiumate's capabilities:
+
+- **Generating Tests**: Codiumate simplifies the creation of comprehensive test suites for your code. [Start generating tests](../tests/index.md).
+- **Chat**: Engage with Codiumate's chat for code assistance, documentation generation, and more. [Learn about Chat](../chat/index.md).
+
+Codiumate is designed to seamlessly integrate into your development process, providing tools and features that enhance productivity, code quality, and team collaboration. Enjoy the journey to more efficient and enjoyable coding with Codiumate.