Skip to content

Commit 1199f12

Browse files
committedMar 18, 2024··
Fix Jira and Linear integration descriptions
1 parent dfe5827 commit 1199f12

File tree

3 files changed

+4
-5
lines changed

3 files changed

+4
-5
lines changed
 

‎docs/integrations/Jira/link.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,9 @@ Upon posting the review findings, CodeRabbit provides details about the issue's
4040

4141
### Finding Related Issues
4242

43-
One of the key features of CodeRabbit's Jira integration is its ability to discover existing related jira issues addressed in the pull request. Leveraging RAG (Retrieval-Augmented Generation), CodeRabbit enhances its AI capabilities. RAG empowers AI models to incorporate external data sources beyond their training sets or predefined parameters, thereby enhancing their responses to given prompts.
43+
One of the key features of CodeRabbit's Jira integration is its ability to discover existing related Jira issues addressed in the pull request. Leveraging RAG (Retrieval-Augmented Generation), CodeRabbit enhances its AI capabilities. RAG empowers AI models to incorporate external data sources beyond their training sets or predefined parameters, thereby enhancing their responses to given prompts.
4444

4545
After integrating with Jira, CodeRabbit scans through open issues, indexing them for future reference. This means that pre-existing issues are retrieved, indexed into a Vector database, and subsequently searched for each new pull request.
46-
4746
:::info
4847
Indexing occurs periodically on a scheduled basis. As a result, newly created issues or those not yet scheduled for indexing may not be immediately detected by CodeRabbit.
4948
:::

‎docs/integrations/Jira/setup.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ Lastly, Jira will ask you to authorize CodeRabbit for read access to Jira Issues
5252

5353
**That's It!** Jira will redirect you back to the CodeRabbit integrations page where you should see the toggle enabled for the Jira Integration.
5454

55-
### Disconnect CodeRabbit with Linear
55+
### Disconnect CodeRabbit with Jira
5656

57-
Disconnecting the integration is seamless. Just toggle the button off for the Linear Integration and CodeRabbit will automatically disconnect.
57+
Disconnecting the integration is seamless. Just toggle the button off for the Jira Integration and CodeRabbit will automatically disconnect.
5858

5959
---
6060

‎docs/integrations/Linear/link.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ When the pull request is submitted with the associated Linear Issue ID, CodeRabb
4242
You can view the assessment outcome in the Walkthrough section of CodeRabbit's Review.
4343
:::
4444

45-
Upon posting the review findings, CodeRabbit provides details about the issue's objectives, confirms whether they were met, and offers additional explanations if needed. For example here the developer added the division functionality for the simple calculator in the pull request. CodeRabbit was able to find that issue, assess whether the pull request did indeed resolve the issue, and provided the assessment as seen below.
45+
Upon posting the review findings, CodeRabbit provides details about the issue's objectives, confirms whether they were met, and offers additional explanations if needed. For example, here, the developer added the division functionality for the simple calculator in the pull request. CodeRabbit was able to find that issue, assess whether the pull request did indeed resolve the issue, and provided the assessment as seen below.
4646

4747
![Linear Issue Response](../images/Linear/link/linear-assessment.png)
4848

0 commit comments

Comments
 (0)
Please sign in to comment.