From eb44ecb1be93da9808ca3d01e9285a0d3a3eb9b5 Mon Sep 17 00:00:00 2001 From: "Hussam.lawen" Date: Mon, 4 Nov 2024 17:18:18 +0200 Subject: [PATCH] update docs --- docs/docs/core-abilities/fetching_ticket_context.md | 4 ++-- docs/docs/core-abilities/index.md | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/docs/core-abilities/fetching_ticket_context.md b/docs/docs/core-abilities/fetching_ticket_context.md index 7b6bd5e79..cf8aa8d9f 100644 --- a/docs/docs/core-abilities/fetching_ticket_context.md +++ b/docs/docs/core-abilities/fetching_ticket_context.md @@ -9,7 +9,7 @@ This integration enriches the review process by automatically surfacing relevant Ticket Recognition Requirements: 1. The PR description should contain a link to the ticket. -2. For Jira tickets, you should follow the instructions in #jira-integration in order to authenticate with Jira. +2. For Jira tickets, you should follow the instructions in [Jira Integration](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/#jira-integration) in order to authenticate with Jira. ### Describe tool @@ -106,7 +106,7 @@ jira_api_email = "YOUR_EMAIL" Currently, we only support the Personal Access Token (PAT) Authentication method. 1. Create a [Personal Access Token (PAT)](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html) in your Jira account -2. In your [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/) add the following lines: +2. In your Configuration file/Environment variables/Secrets file, add the following lines: ```toml [jira] diff --git a/docs/docs/core-abilities/index.md b/docs/docs/core-abilities/index.md index 51f01b696..7059b83ee 100644 --- a/docs/docs/core-abilities/index.md +++ b/docs/docs/core-abilities/index.md @@ -1,5 +1,6 @@ # Core Abilities Qodo Merge utilizes a variety of core abilities to provide a comprehensive and efficient code review experience. These abilities include: + - [Fetching ticket context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) - [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/) - [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/)