Skip to content

Commit

Permalink
Update documentation for Codiumate and PR-Agent with new features and…
Browse files Browse the repository at this point in the history
… versions
  • Loading branch information
almog-lv committed Jun 9, 2024
1 parent b14d9e8 commit 99a0259
Show file tree
Hide file tree
Showing 10 changed files with 276 additions and 44 deletions.
44 changes: 21 additions & 23 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Discover more about Cover-Agent in our detailed [**blog post**](https://www.codi
<div markdown class="bg-black">
<h3 markdown class="top-left">

**[<b class="white">:simple-jetbrains:</b> Codiumate<b class="green">:</b>JetBrains | v0.7.34](./versions/latest/jetbrains.md)**
**[<b class="white">:simple-jetbrains:</b> Codiumate<b class="green">:</b>JetBrains | v0.7.38](./versions/latest/jetbrains.md)**
</h3>

![type:video](https://www.youtube.com/embed/EjrgjBOLPGc?si=6ls9f4MMLuOKcayn){ align=right}
Expand Down Expand Up @@ -133,30 +133,36 @@ Codiumate plugin now supports comprehensive chat functionalities in JetBrains! T

<h3 markdown class="top-left">

**[<b class="white">:fontawesome-solid-robot:</b> PR<b class="green">-</b>Agent | v0.21](./versions/latest/pr-agent.md)**
**[<b class="white">:fontawesome-solid-robot:</b> PR<b class="green">-</b>Agent | v0.22](./versions/latest/pr-agent.md)**
</h3>

<div markdown class="centered">

# PR-Agent **Chrome Extension** 🕵️‍♂️

<div class="left-padding" markdown>

![type:video](https://www.youtube.com/embed/gT5tli7X4H4?si=OLuud-51eoboJN1T){ align=left}
### Apply Code Suggestion with **One Click**

In the latest PR-Agent Pro we've introduced a new way of improving your code:

You can now Interactively convert a specific suggestion to a committable one, with just checking the check-box inside each suggesion!


---

### **Chrome Extension** v1.15 🕵️‍♂️

<div class="left-padding" markdown>

To make your PR review process smoother and more efficient, we’ve launched a new Chrome extension for PR-Agent, designed for GitHub repositories where PR-Agent is installed.
![type:video](https://www.youtube.com/embed/v9bJ1frtPcg?si=8dgarF21BWqKBjr9){ align=left}

This extension adds a convenient toolbar above the PR comment section, giving you quick access to all PR-Agent tools.

You can now customize settings for each tool directly from this toolbar.
<div class="left-padding" markdown>

### The new PR-Agent Chrome Extension version now added 2 new features:

**Key Features:**
- PR-Agent **Filters** - Easily switch between PR-Agent comments, Non-PR-Agent comments, and all comments to focus on what matters.

- Conveniently access a variety of PR-Agent tools directly from the comment section on your pull request page.
- Streamlined Configuration Export: Effortlessly export your preferred PR-Agent settings to a configuration file, which can be applied at either the repository or organizational level for seamless team-wide adoption.
- Supported tools: `\describe`, `\review`, `\improve`, `\ask`, `\update_changelog`, `\docs`, `\analyze`, `\actions`
- **Enhanced** Code Suggestions - Use the new quote button to add specific code suggestions as comments and tag your teammates for seamless collaboration.


<div markdown class="centered">
Expand All @@ -167,6 +173,7 @@ You can now customize settings for each tool directly from this toolbar.
</div>
</div>


<!-- FOOTER -->

<!-- What's cooking -->
Expand All @@ -183,24 +190,15 @@ You can now customize settings for each tool directly from this toolbar.
# What's **Cooking**?

<div class="left-padding" markdown>
!!! vscode "Codiumate:VSCode >> Project Context"
We are working on adding another level of chat context - **Project Level Context**. This will enable you to add any folder as a context to the chat, and even you're entire project!

This functionality will help you ask any question about your project, search for implementations inside your project and improve the results of all the commands and generated tests.

**Stay tuned!**

!!! jetbrains "Codiumate:JetBrains >> Code Completion"
Code Completion is already available for Codiumate:VSCode, and we're diligently integrating it into Codiumate:JetBrains for an enhanced coding experience.

Our Code Completion feature is designed to expedite your coding process by intelligently analyzing code context and intentions. It seamlessly suggests relevant code snippets, allowing you to swiftly accept them with a simple tab click.

**[Read More about Code Completion](https://codiumate-docs.codium.ai/code-completion/)**


!!! pr-agent "PR-Agent >> Chrome-Extension"
The first PR-Agent Chrome Extension was released this week, next we're planning to add support for other Git providers and add more capabilities to watch PR-Agent responses inside the extension.

!!! code "Codiumate:Test >> Improved test generation"
These days we're working on improving the test quality - starting from a better context selection, project indexing for better mocking and learning from specific language best practices.

</div>
</div>
Expand Down
90 changes: 90 additions & 0 deletions docs/versions/2024-05-05/jetbrains.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
hide:
- navigation
- toc
title: Codiumate JetBrains Release Notes
subtitle: Codiumate plugin for JetBrains v0.7.30 Release Notes
---
<div class="content" markdown>
<div class="bg-clear" markdown>

<div markdown class="centered">
![](../../assets/jetbrains.png){ class="no-border"}

### v0.7.34 | May 5, 2024

<div markdown class="bg-blue">

<div markdown class="content">
# Full **Chat Support**

We are excited to announce that Codiumate:Chat for Jetrains now supports all modes and commands!


After much hard work, we're proud to say that we now support all three modes and all the commands in Codiumate Chat for JetBrains!

## **What can you do with Codiumate Chat?**



<div class="grid cards" markdown>

- :fontawesome-solid-file-lines:{ .lg .middle } File Mode

---

Choose any code in your project and explore the different commands - explain the code, improve the quality, write tests, add docstring, and more.

[:octicons-arrow-right-24: Read More](https://codiumate-docs.codium.ai/chat/modes/file-mode/)

- :fontawesome-solid-folder-tree:{ .lg .middle } Workspace Mode

---

Choose a changeset (local or committed changes) and improve your code before you commit or push - get a recap of your changes, find and fix issues in your diff, get a code review, update the changelog, and more.


[:octicons-arrow-right-24: Read More](https://codiumate-docs.codium.ai/chat/modes/workspace-mode/)

- :fontawesome-solid-comment-dots:{ .lg .middle } Free Chat Mode

---

Chat about any code-related subject, with your code as context.


[:octicons-arrow-right-24: Read More](https://codiumate-docs.codium.ai/chat/modes/free-chat/)


</div>

You can always click "Continue this chat" in the response to explore further and add more requests.

You can add more context to the chat by selecting the code, right-clicking on it, and selecting "Add to Codiumate as context."

### **[Read more about Codiumate:Chat](https://codiumate-docs.codium.ai/chat/)**

![type:video](https://www.youtube.com/embed/EjrgjBOLPGc?si=6ls9f4MMLuOKcayn){: style='width: 60%; height: 30.172vw'}

---


## What’s Next?

!!! code "Code Completion"
We're working on adding Code Completion to Codiumate:JetBrains, stay tuned!

!!! folder "Project Context"
We're adding an option to add your entire project, or any selected folder, as context to the chat and test generation.

**Stay Tuned!**

---

### **[Read CodiumAI Release Notes Digest](../../index.md)**

</div>
</div>
</div>
</div>
</div>
58 changes: 58 additions & 0 deletions docs/versions/2024-05-05/pr-agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
hide:
- navigation
- toc
---

<div markdown class="centered">
![](../../assets/pr-agent.png){ class="no-border"}
### v0.21 | May 5, 2024

<div class="content" markdown>
<div class="bg-blue" markdown>
<div class="content" markdown>



# PR-Agent **Chrome Extension** 🕵️‍♂️

To make your PR review process smoother and more efficient, we’ve launched a new Chrome extension for PR-Agent, designed for GitHub repositories where PR-Agent is installed.

This extension adds a convenient toolbar above the PR comment section, giving you quick access to all PR-Agent tools.

You can now customize settings for each tool directly from this toolbar.

## **Key Features:**


<div class="left-padding" markdown>

- Conveniently access a variety of PR-Agent tools directly from the comment section on your pull request page.
- Streamlined Configuration Export: Effortlessly export your preferred PR-Agent settings to a configuration file, which can be applied at either the repository or organizational level for seamless team-wide adoption.
- Supported tools:
- 📝 Describe: Generate a description for the PR - title, type, summary, walkthrough and labels
- 🔍 Review: Provide various feedbacks on the PR such as possible issues, security concerns, and more
- ✨ Improve: Generate code suggestions, focusing on possible issues, efficiency, best practices, and more'
- ❓ Ask: Answer questions about the PR, based on the PR code changes
- 🔄 Update Change Log: Automatically update the CHANGELOG.md file based on the PR code changes
- 📚 Docs 💎: Suggest documentation for any code components that changed in the PR
- 🔬 Analyze 💎: Identifies code components that changed in the PR, and enables to interactively trigger relevant tools
- 🚦 Actions 💎: Receives a URL of a failed Github action, and analyzes why the process failed

</div>

<div markdown class="centered">
### **[Download Chrome Extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl)**

![type:video](https://www.youtube.com/embed/gT5tli7X4H4?si=OLuud-51eoboJN1T){: style='width: 60%; height: 30.172vw'}
</div>

---

### **[Read CodiumAI Release Notes Digest](../../index.md)**


</div>
</div>
</div>
</div>
Binary file added docs/versions/2024-05-30/current-file.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/versions/2024-05-30/extra-context.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
58 changes: 58 additions & 0 deletions docs/versions/2024-05-30/vscode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
hide:
- navigation
- toc
title: Codiumate VScode Release Notes
subtitle: Codiumate plugin for JetBrains v0.7.30 Release Notes
---

<div class="centered" markdown>
![](../../assets/vscode.png){ class="no-border"}

### v0.9 | May 30, 2024

<div class="content" markdown>
<div class="bg-blue" markdown>
<div class="content" markdown>

###
# New Chat Interface with **Project Context**!

We're excited to unveil Codiumate v0.9, which introduces a sleek, redesigned interface and enhanced **project indexing capabilities**. This update makes navigating and using Codiumate Chat more intuitive and user-friendly, allowing you to quickly select your coding focus with new shortcuts like `@` and the `+` button.

We've also expanded the ways you can add context to your requests—now including code snippets, files, folders, or your entire project, ensuring responses are precisely tailored to your needs. Additionally, the new coding-agent can be activated with just a click, providing expert assistance tailored to your coding challenges.


### **🤩 See how it looks:**

#### Choose focus
![](current-file.gif){width=70%}

#### Add Extra Context
![](extra-context.gif){width=70%}


---

## Using **GPT-4o** in Test Generation

The latest update to Codiumate incorporates GPT-4o, an advanced iteration of the Generative Pre-trained Transformer model, to revolutionize the way we generate tests. This integration significantly enhances our ability to produce intelligent, context-aware test suggestions. With GPT-4o, developers can expect more refined and accurate test cases, which are crucial for maintaining high-quality software.

---

## Adding **Vitest** Framework to Supported Frameworks List

After much anticipation, we are thrilled to announce the addition of the Vitest framework to Codiumate's list of supported testing frameworks in JavaScript and TypeScript. Vitest, a modern testing framework tailored for JavaScript environments, aligns perfectly with the needs of contemporary developers.

---

**Stay tuned for more updates!**

---

### **[Read CodiumAI Release Notes Digest](../../index.md)**

</div>
</div>
</div>
</div>
Binary file added docs/versions/latest/improve-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/versions/latest/improve-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 16 additions & 3 deletions docs/versions/latest/jetbrains.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ subtitle: Codiumate plugin for JetBrains v0.7.30 Release Notes
<div markdown class="centered">
![](../../assets/jetbrains.png){ class="no-border"}

### v0.7.34 | May 5, 2024
### v0.7.38 | May 30, 2024

<div markdown class="bg-blue">

<div markdown class="content">
##
# Full **Chat Support**

We are excited to announce that Codiumate:Chat for Jetrains now supports all modes and commands!
Expand All @@ -26,7 +27,6 @@ After much hard work, we're proud to say that we now support all three modes and
## **What can you do with Codiumate Chat?**



<div class="grid cards" markdown>

- :fontawesome-solid-file-lines:{ .lg .middle } File Mode
Expand Down Expand Up @@ -69,7 +69,20 @@ You can add more context to the chat by selecting the code, right-clicking on it
---


## What’s Next?

## More **News**

<div class="left-padding" markdown>

- We added more options in inlays (above class/function) with some Chat commands to invoke.
- Added word-wrap enable/disable button for code blocks in Chat.
- Improved `/recap` and `/issues` performance.

</div>

---

## What’s **Next**?

!!! code "Code Completion"
We're working on adding Code Completion to Codiumate:JetBrains, stay tuned!
Expand Down
Loading

0 comments on commit 99a0259

Please sign in to comment.