Skip to content

Commit 498a877

Browse files
Hackathon - Cody Web (#766)
<!-- Explain the changes introduced in your PR --> ## Pull Request approval You will need to get your PR approved by at least one member of the Sourcegraph team. For reviews of docs formatting, styles, and component usage, please tag the docs team via the #docs Slack channel. --------- Co-authored-by: Maedah Batool <[email protected]>
1 parent ff0fc40 commit 498a877

File tree

1 file changed

+16
-25
lines changed

1 file changed

+16
-25
lines changed

docs/cody/clients/cody-with-sourcegraph.mdx

Lines changed: 16 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<p className="subtitle">Learn how to use Cody in the web interface with your Sourcegraph.com instance.</p>
44

5-
In addition to the Cody extensions for [VS Code](/cody/clients/install-vscode) and [JetBrains](/cody/clients/install-jetbrains) IDEs, Cody is also available in the Sourcegraph web app. Community users can use Cody for free by logging into their accounts on Sourcegraph.com, and enterprise users can use Cody within their Sourcegraph instance.
5+
In addition to the Cody extensions for [VS Code](/cody/clients/install-vscode), [JetBrains](/cody/clients/install-jetbrains) and [Visual Studio](/cody/clients/install-visual-studio ) IDEs, Cody is also available in the Sourcegraph web app. Community users can use Cody for free by logging into their accounts on Sourcegraph.com, and enterprise users can use Cody within their Sourcegraph instance.
66

77
<LinkCards>
88
<LinkCard href="https://sourcegraph.com/cody/chat" imgSrc="https://sourcegraph.com/.assets/img/sourcegraph-mark.svg" imgAlt="Cody for Web" title="Cody for Web" description="Use Cody in the Sourcegraph Web App." />
@@ -19,48 +19,39 @@ Create a [Sourcegraph.com account](https://sourcegraph.com/sign-up) by logging i
1919

2020
Enterprise users can also log in to their Sourcegraph.com Enterprise instance and use Cody in the web interface.
2121

22-
## Chat Interface
22+
## Chat interface
2323

24-
The chat interface for Cody on the web is similar to the one you get with the [VS Code](/cody/clients/install-vscode#chat) editor extension. If you click the Cody chat from the top header, you will see a **Start new chat +** button in the bottom left sidebar with the chat editor. All your previous chats appear in this left sidebar. To delete any chat, hover over the chat and click the **Delete** icon.
24+
The Cody chat interface for the web is similar to the one you get with the IDE extensions. However, the chat experience is slightly different depending on whether you use Cody with your search query results or directly from the top header.
2525

26-
The chat interface with your Code Search queries is operated per chat. You cannot run multiple chats and store them in parallel. A new chat window opens whenever you click the Cody button from the query editor or the top header.
26+
The chat interface with your Code Search queries opens parallel to your query search results, similar to the chat window in the IDE extensions. However, when you click **Cody** from the top header in your Sourcegraph.com instance, the chat interface opens on a new page.
2727

28-
<Callout type="info"> The new and improved chat UI for Cody for web is currently available to users on Sourcegraph versions >=5.5. It's recommeded to update your Sourcegraph instance to the latest version to use this new chat interface. </Callout>
28+
<Callout type="info"> The new and improved chat UI for Cody for the web is currently available to users on Sourcegraph versions >=5.5. To use this new chat interface, you should update your Sourcegraph instance to the latest version.</Callout>
2929

30-
## LLM Selection
30+
## Chat with Cody on the web interface
3131

32-
Cody Free and Pro users can select multiple models. Enterprise users with the new [model configuration](/cody/clients/model-configuration) can use the LLM selection dropdown to choose a chat model.
32+
The feature set for the Cody chat is the same as the IDE extensions. Your previous chats can be viewed from the **History** tab. Claude 3.5 Sonnet (New) is selected as the default chat model. You can change this LLM model based on your use case to optimize speed, accuracy, or cost. Enterprise users with the new [model configuration](/cody/clients/model-configuration) can use the LLM selection dropdown to choose a chat model. You can read about these supported LLM models [here](/cody/capabilities/supported-models#chat-and-commands).
3333

34-
You can read about these supported LLM models [here](/cody/capabilities/supported-models#chat-and-commands).
34+
To help you automate your key tasks in your development workflow, you get **[Prompts](/cody/capabilities/commands)**. If you are a part of an organization on Sourcegraph.com or a self-hosted Sourcegraph instance, you can view these pre-built Prompts created by your teammates. On the contrary, you can create your Prompts via the **Prompt Library** from your Sourcegraph instance.
3535

36-
![LLM-models-for-cody-free](https://storage.googleapis.com/sourcegraph-assets/Docs/llm-dropdown-options-102024.png)
36+
## Context selection
3737

38-
## Selecting Context with @-mentions
38+
If you use Cody with your search results, the chat input will, by default, have the context of your searched codebase. This context is based on your current repository and file.
3939

40-
Cody chat with a Sourcegraph.com instance allows you to add files and symbols as context in your messages.
40+
![cody-web-with-search](https://storage.googleapis.com/sourcegraph-assets/Docs/cody-web-search-results-1124.png)
4141

42-
- Type `@file` and then a filename to include a file as a context
43-
- Type `@` and you can also add **Symbols**, **Files**, and **Repositories** as context
42+
You can add or delete any new or existing context by `@-mentioning` files, symbols, directories, repositories, and web URLs. Enterprise users can `@-mention` remote directories as well. When you have both a repository and files as context, Cody will search the repository for context while prioritizing the mentioned files.
4443

45-
### Context retrieval
44+
If you use Cody directly from the top header, the chat input will have no pre-filled context chips by default. You can chat without context or add or delete any new or existing context by `@-mentioning` context chips.
4645

47-
When you start a new Cody chat inside the search query window, the chat input window opens with a default `@-mention` context chip for all the context it intends to use. This context is based on your current repository and current file.
48-
49-
At any point in time, you can edit these context chips or remove them completely if you do not want to use these as context. Any chat without a context chip will instruct Cody to use no codebase context. However, you can always provide an alternate `@-mention` file or symbols to let Cody use it as a new context source.
50-
51-
When you have both a repository and files @-mentioned, Cody will search the repository for context while prioritizing the mentioned files.
52-
53-
<Callout type="info">Using your own [custom OpenCtx providers](https://sourcegraph.com/docs/cody/capabilities/openctx) will not be supported with chat on Cody for Web.</Callout>
46+
![cody-web-no-search](https://storage.googleapis.com/sourcegraph-assets/Docs/cody-web-top-header-1124.png)
5447

5548
### Rerun prompts with different context
5649

5750
If Cody's answer isn't helpful, you can try asking again with a different context:
5851

59-
- **Public knowledge only**: Cody will not use your own code files as context; it’ll only use knowledge trained into the base model
52+
- **Public knowledge only**: Cody will not use your code files as context; it’ll only use knowledge trained into the base model
6053
- **Add context**: Provides @-mention context options to improve the response by explicitly including files, symbols, and remote repositories
6154

6255
![re-run-prompts](https://storage.googleapis.com/sourcegraph-assets/Docs/rerun-prompt-web-0724.jpg)
6356

64-
## Prompts
65-
66-
Prompts and the Prompt Library are supported in Cody for Web. You can access these from the **prompts** selector drop-down in the chat interface. Read more about prompts and the Prompt Library [here](/cody/capabilities/commands).
57+
<Callout type="tip">For a detailed breakdown of Cody's capabilities across different clients [read these feature parity docs](/cody/clients/feature-reference).</Callout>

0 commit comments

Comments
 (0)