Skip to content

Commit

Permalink
update knowledge base documentation (#52673)
Browse files Browse the repository at this point in the history
  • Loading branch information
kimlalman28 authored Oct 16, 2024
1 parent bfb04bf commit f170b0b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ redirect_from:

{% data variables.product.prodname_copilot %}'s ability to answer natural language questions, in the context of a {% data variables.product.prodname_dotcom %} repository, is improved when the repository has been indexed for semantic code search.

Indexing repositories is not a requirement and will not affect responses to questions about information in knowledge bases, pull requests, issues, discussions, or commits. However, indexing can help {% data variables.product.prodname_copilot_chat_short %} answer questions that relate directly to the code within a repository.
Indexing repositories is not a requirement and will not affect responses to questions about information in pull requests, issues, discussions, or commits. However, indexing can help {% data variables.product.prodname_copilot_chat_short %} answer questions that relate directly to the code within a repository.

The indexing status of a repository is displayed on {% data variables.product.github %} when you start a conversation that has a repository context. You can index the repository if it has not been indexed yet.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ Knowledge bases you create will be accessible by all organization members with a
{% data reusables.profile.access_org %}
{% data reusables.profile.org_settings %}

1. In the left sidebar, click **{% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %}** then click **Customize**.
1. To the right of "Knowledge", click **Add knowledge base**.
1. In the left sidebar, click **{% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %}** then click **Knowledge bases**.
1. To the right of "Knowledge bases", click **New knowledge base**.
1. In the "Name" field, enter a unique name for the knowledge base. Optionally, in the "Description" field, you can add a description for the knowledge base.

![Screenshot of the "Add knowledge base" page.](/assets/images/help/copilot/copilot-create-knowledge-base-page.png)
![Screenshot of the "New knowledge base" page.](/assets/images/help/copilot/copilot-create-knowledge-base-page.png)

1. Under "Content", to see a full list of available repositories, click **Select repositories**.

Expand All @@ -54,7 +54,7 @@ Knowledge bases you create will be accessible by all organization members with a

![Screenshot of the "Select repositories" page.](/assets/images/help/copilot/copilot-select-repositories-page.png)

1. Optionally, you can define which paths within the selected repositories to index.
1. Optionally, you can specify particular paths within the selected repositories for searches. When a search is conducted using the knowledge base, only the files located in those designated paths will be included in the results. For more information on specifying repository paths, see "[AUTOTITLE](/search-github/github-code-search/understanding-github-code-search-syntax#path-qualifier)"

* Click **Edit file paths**.

Expand All @@ -71,7 +71,7 @@ Organization owners can update a knowledge base created in their organization.
{% data reusables.profile.access_org %}
{% data reusables.profile.org_settings %}

1. In the left sidebar, click **{% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %}** then click **Customize**.
1. In the left sidebar, click **{% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %}** then click **Knowledge bases**.
1. To the right of the knowledge base you want to edit, click {% octicon "pencil" aria-label="The pencil symbol" %}.
1. Make your desired changes to your knowledge base.
1. Click **Update knowledge base**.
Expand All @@ -83,6 +83,10 @@ Organization owners can delete a knowledge base created in their organization.
{% data reusables.profile.access_org %}
{% data reusables.profile.org_settings %}

1. In the left sidebar, click **{% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %}** then click **Customize**.
1. In the left sidebar, click **{% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %}** then click **Knowledge bases**.
1. To the right of the knowledge base you want to delete, click {% octicon "trash" aria-label="The trash symbol" %}.
1. In the "Confirm deletion" dialog box, review the information and click **Delete**.

## Indexing repositories within a knowledge base

For more information about indexing, see "[AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/customizing-copilot-for-your-organization/indexing-repositories-for-copilot-chat)"

0 comments on commit f170b0b

Please sign in to comment.