From ce1384753967afedeb6d54775bf7809177c2d370 Mon Sep 17 00:00:00 2001 From: Amy Chan Date: Wed, 17 Sep 2025 13:29:02 -0700 Subject: [PATCH 1/2] Fix path in docusaurus.config.js to resolve broken links --- docusaurus.config.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 9ba6bb8..201f407 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -128,7 +128,7 @@ const config = { }, { label: 'Developer', // You can add more internal doc links here - to: '/docs/getting-started/developer/', + to: '/docs/category/developer/', }, // Add more internal docs here if needed ], @@ -381,7 +381,7 @@ const config = { items: [ { label: 'Product', - to: 'https://datacoves.co/product', + to: 'https://datacoves.com/product', }, { label: 'Blog', From c409ace1a342921521c618d3f786313bd516edc3 Mon Sep 17 00:00:00 2001 From: Amy Chan Date: Wed, 17 Sep 2025 14:26:04 -0700 Subject: [PATCH 2/2] Update Datacoves Copilot section, add v1/v2 pages with tabs, backup previous md pages --- .../snowflake/{README.md => README.txt} | 0 docs/best-practices/snowflake/_category_.yaml | 8 + docs/best-practices/vscode/README.md | 2 +- .../{v1-llm.mdx => v1-llm-backup.txt} | 0 ...llm-config.md => v1-llm-config-backup.txt} | 0 docs/how-tos/vscode/datacoves-copilot/v1.md | 131 ++++++++- ...llm-config.md => v2-llm-config-backup.txt} | 0 docs/how-tos/vscode/datacoves-copilot/v2.md | 265 +++++++++++++++++- docusaurus.config.js | 2 +- static/llms.txt | 93 +++--- 10 files changed, 433 insertions(+), 68 deletions(-) rename docs/best-practices/snowflake/{README.md => README.txt} (100%) create mode 100644 docs/best-practices/snowflake/_category_.yaml rename docs/how-tos/vscode/datacoves-copilot/{v1-llm.mdx => v1-llm-backup.txt} (100%) rename docs/how-tos/vscode/datacoves-copilot/{v1-llm-config.md => v1-llm-config-backup.txt} (100%) rename docs/how-tos/vscode/datacoves-copilot/{v2-llm-config.md => v2-llm-config-backup.txt} (100%) diff --git a/docs/best-practices/snowflake/README.md b/docs/best-practices/snowflake/README.txt similarity index 100% rename from docs/best-practices/snowflake/README.md rename to docs/best-practices/snowflake/README.txt diff --git a/docs/best-practices/snowflake/_category_.yaml b/docs/best-practices/snowflake/_category_.yaml new file mode 100644 index 0000000..69f1455 --- /dev/null +++ b/docs/best-practices/snowflake/_category_.yaml @@ -0,0 +1,8 @@ +label: Snowflake +position: 1 +link: + type: generated-index + title: Snowflake + description: Here we present some guidance for Snowflake including setting up a scalable security model amd managing time-travel while meeting GDPR requirements. + + diff --git a/docs/best-practices/vscode/README.md b/docs/best-practices/vscode/README.md index aec8718..b92ceee 100644 --- a/docs/best-practices/vscode/README.md +++ b/docs/best-practices/vscode/README.md @@ -2,4 +2,4 @@ title: VS Code sidebar_position: 5 --- -# VS Cod Best Practices and Tips +# VS Code Best Practices and Tips diff --git a/docs/how-tos/vscode/datacoves-copilot/v1-llm.mdx b/docs/how-tos/vscode/datacoves-copilot/v1-llm-backup.txt similarity index 100% rename from docs/how-tos/vscode/datacoves-copilot/v1-llm.mdx rename to docs/how-tos/vscode/datacoves-copilot/v1-llm-backup.txt diff --git a/docs/how-tos/vscode/datacoves-copilot/v1-llm-config.md b/docs/how-tos/vscode/datacoves-copilot/v1-llm-config-backup.txt similarity index 100% rename from docs/how-tos/vscode/datacoves-copilot/v1-llm-config.md rename to docs/how-tos/vscode/datacoves-copilot/v1-llm-config-backup.txt diff --git a/docs/how-tos/vscode/datacoves-copilot/v1.md b/docs/how-tos/vscode/datacoves-copilot/v1.md index 09f7e13..d8eafe6 100644 --- a/docs/how-tos/vscode/datacoves-copilot/v1.md +++ b/docs/how-tos/vscode/datacoves-copilot/v1.md @@ -6,9 +6,132 @@ sidebar_position: 2 This section describes how to configure and use Datacoves Copilot v1. -Datacoves Copilot v1 supports ChatGPT and Azure Open AI LLMs, Datacoves v4+ includes Datacoves Copilot 2.0 which enhances the experience and supports many more LLM providers. +Datacoves Copilot v1 supports ChatGPT and Azure Open AI LLMs. Datacoves v4+ includes Datacoves Copilot 2.0 which enhances the experience and supports many more LLM providers. -# How Tos +## How Tos -- [LLM Config](./v1-llm-config.md) -- [Working with an LLM in Datacoves](./v1-llm.mdx) +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + + +## Configure your LLM for Datacoves Copilot v1 + +:::note Datacoves Copilot v1 only support the 4o model gpt model. +::: +### Step 1: Create a Datacoves Secret + +Creating a [Datacoves Secret](/docs/how-tos/datacoves/how_to_secrets.md) requires some key fields to be filled out: + +- **Name:** The secret must be named `datacoves-copilot-llm-api` +- **Description:** Provide a simple description such as: `Open AI config` +- **Format:** Select `Raw JSON` +- **Value**: The value will vary based on the LLM you are utilizing. + - **Open AI:** You only need your API key. Head to [Open AI](https://platform.openai.com/api-keys) to create your key. `{"OPENAI_API_KEY": "Your key here"}` + - **Azure Open AI:** This requires two credentials. Head to [ai.azure.com](https://ai.azure.com) to find your credentials under the [Deployments](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/working-with-models?tabs=powershell#model-deployment-upgrade-configuration) tab. `{"AZURE_OPENAI_ENDPOINT": "Your endpoint here", "AZURE_OPENAI_API_KEY" : "Your key here"}` +- **Scope:** Select the desired scope, either `Project` or `Environment`. +- **Project/Environment:** Select the `Project` or `Environment` that will access this LLM. + +Lastly, be sure to toggle on the `Share with developers` option so that users with developer access will be able to use the LLM. +![Share with Devs](assets/llm_share_with_devs.png) + +### Example Secret + +![Example ](assets/llm_example.png) + + + + + + +## Working with an LLM in Datacoves Copilot v1 + +Once you have configured your LLM, working with the AI chat is a breeze! + +## Pre-configured presets + +While there are many use cases for AI in the development workflow there are a couple of tasks that come up regularly. To improve the user experience, we have created some presets that provide the LLM with specific instructions to get the best result. Use these or configure your own custom presets. + +Current out of the box presents include: + +- **Document dbt model:** Will provide descriptions for yml file you have open and provided as context. +- **Explain dbt model:** Will explain a dbt model file you have open and provided as context. +- **Explain dbt macro:** Will explain a dbt macro file you have open and provided as context. +- **Add descriptions to CSV:** Will provide descriptions for CSV files you have open and provided as context. + +## How to use the Chat/Presets + +### Extension UI/UX + +To use your LLM head to the Datacoves Power User extension and open up `Copilot`. + +
+ ![LLM Menu](./assets/llm_menu.png) +
+ +### Provide files for context + +The most important thing to remember is providing context to the LLM. In order to do this simply open up the file you wish to work with. + +![llm file open](assets/llm_file_open.png) + +### Send specific lines of code for context + +Highlight the lines of code you wish to send. + +![context lines](assets/llm_line_context.png) + +### Don't provide context + +In the case that you don't want to send an open file for context you can select the icon below. + +![llm context](assets/llm_context.gif) + +## Using LLM code + +Datacoves Copilot makes copying AI generated code simple with 3 options. + +![Code Options](assets/llm_code_options.png) + +### Replace + +Replace the entire code file with the LLM code. + +![llm Replace](assets/llm_replace.gif) + +### Insert + +Insert LLM code into your file. + +![llm Insert](assets/llm_insert.gif) + +### Copy + +Traditional copy and paste. + +![llm Copy](assets/llm_copy.gif) + +### New Chat + +To start a new chat click on the `New Chat` button. + +![New Chat](assets/llm_new_chat.png) + +## Prefer a Video? +
+