-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #20 from Codium-ai/docs/chat-history
Create Chat History page and clear out Threads
- Loading branch information
Showing
15 changed files
with
34 additions
and
121 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
title: Chat History | ||
--- | ||
|
||
# :fontawesome-solid-comments: Chat History | ||
|
||
## Overview | ||
Codiumate Chat maintains a history of your 20 most recent conversations, allowing you to review past interactions, refresh your memory, or explore new topics. You can continue a past chat to dive deeper into a topic or request additional information. | ||
|
||
## Using Chat History | ||
|
||
1. **Initiate a Command:** Call a command by typing it in the chatbox. | ||
2. **Continue the Conversation:** At the end of Codiumate's response, continue the conversation as long as you wish. Codiumate will maintain the context of your initial query, providing tailored responses to your follow-up questions. | ||
3. **Start a new Conversation:** Click on the "New Chat" button on the top right of the chat interface to start a new conversation. Your current chat history will be cleared, and Codiumate will be ready to start a new conversation. | ||
4. **Check your Chat History:** Next to the "New Chat" button, find the History button and click on it. The Chat History interface will open. You can see your latest 20 chats with Codiumate, switch to each one and continue the conversation if you wish. | ||
|
||
Currently, your chat history wouldn't be saved between sessions, and will be deleted once you close VSCode. We are working on adding this feature in the future. Stay tuned! | ||
|
||
## Examples | ||
|
||
!!! example "Using Chat History" | ||
{width=700, loading=lazy} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,54 +0,0 @@ | ||
--- | ||
title: Threads | ||
--- | ||
|
||
# :fontawesome-solid-comments: Threads | ||
|
||
##Overview | ||
Threads are a powerful feature in Qodo Gen designed to enrich your interaction with the AI, allowing for deeper exploration, refinement, and expansion of responses to your commands. By engaging in a thread, you can fine-tune results, request additional information, or direct the conversation to more specific outcomes. This feature supports an iterative dialogue with Qodo Gen, making it possible to evolve initial responses into comprehensive solutions. | ||
|
||
##Supported Commands | ||
Threads enhance the functionality of several Qodo Gen commands by allowing users to delve deeper into their initial inquiries. Below is a list of commands that support the threading option, each linked to its respective documentation page for detailed information: | ||
|
||
- No selected focus: When using the free chat, each message can start a new thread. | ||
- [`/ask`](./commands/ask.md): Pose coding-related queries and receive detailed explanations. | ||
- [`/explain`](./commands/explain.md): Get a thorough explanation of specific code segments or concepts. | ||
- [`/docstring`](./commands/docstring.md): Generate or improve docstrings for better code documentation. | ||
- [`/quick-test`](./commands/quick-test.md): Create initial test suites with the option to refine and expand them. | ||
- [`/commit`](./commands/commit.md): Generate commit messages based on changes, with the ability to fine-tune the message. | ||
- [`/describe`](./commands/describe.md): Obtain structured descriptions of changesets, ideal for pull requests. | ||
- [`/recap`](./commands/recap.md): Summarize code changes in detail, allowing for further clarification and expansion. | ||
- [`/issues`](./commands/issues.md): Identify and explore potential issues within your codebase. | ||
- [`/improve`](./commands/improve.md) (Git-Diff focus only): Suggest improvements for identified issues, enhancing code quality. | ||
- [`/update-changelog`](./commands/update-changelog.md): Automatically update the changelog, with options for customization and additional context. | ||
|
||
After receiving an initial response to these commands, you'll see a "continue this chat" button. Clicking this button will lead you into a thread where you can request more detailed follow-ups, refine the outcome, or explore related topics further. | ||
|
||
|
||
##How to Use Threads | ||
|
||
1. **Initiate a Command**: Start by executing a command as you normally would in the appropriate focus (Free Chat, Current-File focus, or Git-Diff). | ||
2. **Extend the Conversation**: At the end of the response, click the "continue this chat" button to open a thread. This action shifts the dialogue into a focused conversation window where you can build upon the initial response. | ||
3. **Refine and Expand**: Within the thread, you can ask for more details, request modifications, or explore additional scenarios related to your initial query. Qodo Gen will maintain the context of the ongoing conversation, providing tailored follow-up responses. | ||
|
||
##Examples | ||
|
||
!!! example "Git-Diff Issue Resolution" | ||
- **Initial Command**: Call the `/issues` command to identify potential issues in your codebase. | ||
- **In a Thread**: Dive into a specific issue listed in the initial response, asking Qodo Gen for potential solutions or workaround strategies. | ||
|
||
!!! example "Current-File Test Suite Refinement" | ||
- **Initial Command**: Use `/quick-test` to generate an initial test suite for a piece of code. | ||
- **In a Thread**: Request refinements to the test suite, such as adding more tests, changing the testing framework, incorporating mocks, or adjusting to different testing scenarios. | ||
|
||
!!! example "Free Chat Code Evolution" | ||
- **Initial Request**: Ask Qodo Gen to generate a class based on your specifications. | ||
- **In a Thread**: Further develop the class by requesting additional functions, changing coding styles, or integrating design patterns. | ||
|
||
##Benefits of Using Threads | ||
|
||
- **Detailed Exploration**: Threads allow for a granular examination of Qodo Gen's responses, enabling you to get precisely what you need. | ||
- **Iterative Improvement**: You can iteratively refine Qodo Gen's output, ensuring the final result closely matches your requirements. | ||
- **Contextual Continuity**: Threads maintain the context of your conversation, allowing Qodo Gen to provide more accurate and relevant responses with each interaction. | ||
|
||
Threads are an essential tool in Qodo Gen, bridging the gap between initial automated responses and the nuanced, detailed solutions developers need. By leveraging threads, you ensure that your interactions with Qodo Gen are as productive and informative as possible. | ||
Oops, something went wrong.