From 4a01ca01abf63bdb3751569acce9cbb5cf405b40 Mon Sep 17 00:00:00 2001 From: Amy Chan Date: Thu, 18 Sep 2025 17:29:02 -0700 Subject: [PATCH] update README to use npm and reduced images --- README.md | 10 +- .../metrics-and-logs/README.md | 2 +- .../assets/dashboards-list.png | Bin .../assets/dashboards-nav.png | Bin .../assets/grafana-alerting-menu.jpg | Bin .../metrics-and-logs/assets/grafana-eye.jpg | Bin .../assets/grafana-view-in-explorer.jpg | Bin .../metrics-and-logs/assets/grafana-view.jpg | Bin .../assets/metrics-and-logs-nav.png | Bin .../metrics-and-logs/grafana.md | 0 .../metrics-and-logs/view-failed-git-sync.md | 0 .../datacoves-copilot/v1-llm-backup.txt | 87 ---- .../v1-llm-config-backup.txt | 29 -- .../v2-llm-config-backup.txt | 253 ---------- docs/how-tos/vs-code/initial.mdx | 295 +++++++----- docusaurus.config.js | 6 +- static/llms.txt | 453 ++++++++++-------- 17 files changed, 434 insertions(+), 701 deletions(-) rename docs/how-tos/{ => datacoves}/metrics-and-logs/README.md (93%) rename docs/how-tos/{ => datacoves}/metrics-and-logs/assets/dashboards-list.png (100%) rename docs/how-tos/{ => datacoves}/metrics-and-logs/assets/dashboards-nav.png (100%) rename docs/how-tos/{ => datacoves}/metrics-and-logs/assets/grafana-alerting-menu.jpg (100%) rename docs/how-tos/{ => datacoves}/metrics-and-logs/assets/grafana-eye.jpg (100%) rename docs/how-tos/{ => datacoves}/metrics-and-logs/assets/grafana-view-in-explorer.jpg (100%) rename docs/how-tos/{ => datacoves}/metrics-and-logs/assets/grafana-view.jpg (100%) rename docs/how-tos/{ => datacoves}/metrics-and-logs/assets/metrics-and-logs-nav.png (100%) rename docs/how-tos/{ => datacoves}/metrics-and-logs/grafana.md (100%) rename docs/how-tos/{ => datacoves}/metrics-and-logs/view-failed-git-sync.md (100%) delete mode 100644 docs/how-tos/vs-code/datacoves-copilot/v1-llm-backup.txt delete mode 100644 docs/how-tos/vs-code/datacoves-copilot/v1-llm-config-backup.txt delete mode 100644 docs/how-tos/vs-code/datacoves-copilot/v2-llm-config-backup.txt diff --git a/README.md b/README.md index d63b44fb..e6e6b9b3 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,13 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati ## Installation ```bash -yarn +npm install ``` ## Local Development ```bash -yarn start +npm run start ``` This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. @@ -19,7 +19,7 @@ This command starts a local development server and opens up a browser window. Mo ## Build ```bash -yarn build +npm run build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. @@ -29,13 +29,13 @@ This command generates static content into the `build` directory and can be serv Using SSH: ```bash -USE_SSH=true yarn deploy +USE_SSH=true npm run deploy ``` Not using SSH: ```bash -GIT_USER= yarn deploy +GIT_USER= npm run deploy ``` diff --git a/docs/how-tos/metrics-and-logs/README.md b/docs/how-tos/datacoves/metrics-and-logs/README.md similarity index 93% rename from docs/how-tos/metrics-and-logs/README.md rename to docs/how-tos/datacoves/metrics-and-logs/README.md index ed889a58..8aafb3d9 100644 --- a/docs/how-tos/metrics-and-logs/README.md +++ b/docs/how-tos/datacoves/metrics-and-logs/README.md @@ -1,6 +1,6 @@ --- title: Metrics & Logs -sidebar_position: 7 +sidebar_position: 70 --- # Metrics and Logs How Tos diff --git a/docs/how-tos/metrics-and-logs/assets/dashboards-list.png b/docs/how-tos/datacoves/metrics-and-logs/assets/dashboards-list.png similarity index 100% rename from docs/how-tos/metrics-and-logs/assets/dashboards-list.png rename to docs/how-tos/datacoves/metrics-and-logs/assets/dashboards-list.png diff --git a/docs/how-tos/metrics-and-logs/assets/dashboards-nav.png b/docs/how-tos/datacoves/metrics-and-logs/assets/dashboards-nav.png similarity index 100% rename from docs/how-tos/metrics-and-logs/assets/dashboards-nav.png rename to docs/how-tos/datacoves/metrics-and-logs/assets/dashboards-nav.png diff --git a/docs/how-tos/metrics-and-logs/assets/grafana-alerting-menu.jpg b/docs/how-tos/datacoves/metrics-and-logs/assets/grafana-alerting-menu.jpg similarity index 100% rename from docs/how-tos/metrics-and-logs/assets/grafana-alerting-menu.jpg rename to docs/how-tos/datacoves/metrics-and-logs/assets/grafana-alerting-menu.jpg diff --git a/docs/how-tos/metrics-and-logs/assets/grafana-eye.jpg b/docs/how-tos/datacoves/metrics-and-logs/assets/grafana-eye.jpg similarity index 100% rename from docs/how-tos/metrics-and-logs/assets/grafana-eye.jpg rename to docs/how-tos/datacoves/metrics-and-logs/assets/grafana-eye.jpg diff --git a/docs/how-tos/metrics-and-logs/assets/grafana-view-in-explorer.jpg b/docs/how-tos/datacoves/metrics-and-logs/assets/grafana-view-in-explorer.jpg similarity index 100% rename from docs/how-tos/metrics-and-logs/assets/grafana-view-in-explorer.jpg rename to docs/how-tos/datacoves/metrics-and-logs/assets/grafana-view-in-explorer.jpg diff --git a/docs/how-tos/metrics-and-logs/assets/grafana-view.jpg b/docs/how-tos/datacoves/metrics-and-logs/assets/grafana-view.jpg similarity index 100% rename from docs/how-tos/metrics-and-logs/assets/grafana-view.jpg rename to docs/how-tos/datacoves/metrics-and-logs/assets/grafana-view.jpg diff --git a/docs/how-tos/metrics-and-logs/assets/metrics-and-logs-nav.png b/docs/how-tos/datacoves/metrics-and-logs/assets/metrics-and-logs-nav.png similarity index 100% rename from docs/how-tos/metrics-and-logs/assets/metrics-and-logs-nav.png rename to docs/how-tos/datacoves/metrics-and-logs/assets/metrics-and-logs-nav.png diff --git a/docs/how-tos/metrics-and-logs/grafana.md b/docs/how-tos/datacoves/metrics-and-logs/grafana.md similarity index 100% rename from docs/how-tos/metrics-and-logs/grafana.md rename to docs/how-tos/datacoves/metrics-and-logs/grafana.md diff --git a/docs/how-tos/metrics-and-logs/view-failed-git-sync.md b/docs/how-tos/datacoves/metrics-and-logs/view-failed-git-sync.md similarity index 100% rename from docs/how-tos/metrics-and-logs/view-failed-git-sync.md rename to docs/how-tos/datacoves/metrics-and-logs/view-failed-git-sync.md diff --git a/docs/how-tos/vs-code/datacoves-copilot/v1-llm-backup.txt b/docs/how-tos/vs-code/datacoves-copilot/v1-llm-backup.txt deleted file mode 100644 index 3b5c9ef4..00000000 --- a/docs/how-tos/vs-code/datacoves-copilot/v1-llm-backup.txt +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Usage -sidebar_position: 5 ---- - -# Working with an LLM in Datacoves Copilot v1 - -Once you have [configured your LLM](/how-tos/vscode/datacoves-copilot/v1-llm-config.md), 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? -
-