Merge pull request #498 from Codium-ai/tr/update_pics

Update Image URLs in Markdown Documentation

PR_COMPRESSION.md

@@ -39,4 +39,4 @@ We use [tiktoken](https://github.com/openai/tiktoken) to tokenize the patches af
 4. If we haven't reached the max token length, add the `deleted files` to the prompt until the prompt reaches the max token length (hard stop), skip the rest of the patches.
 
 ### Example
-![](https://codium.ai/images/git_patch_logic.png)
+<kbd><img src=https://codium.ai/images/git_patch_logic.png width="768"></kbd>

README.md

@@ -2,8 +2,13 @@
 
 <div align="center">
 
-<img src="./pics/logo-dark.png#gh-dark-mode-only" width="330"/>
+
-<img src="./pics/logo-light.png#gh-light-mode-only" width="330"/><br/>
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://codium.ai/images/pr_agent/logo-dark.png" width="330">
+  <source media="(prefers-color-scheme: light)" srcset="https://codium.ai/images/pr_agent/logo-light.png" width="330">
+  <img alt="logo">
+</picture>
+<br/>
 Making pull requests less painful with an AI agent
 </div>
 
@@ -174,7 +179,7 @@ There are several ways to use PR-Agent:
 
 The following diagram illustrates PR-Agent tools and their flow:
 
-![PR-Agent Tools](https://www.codium.ai/wp-content/uploads/2023/10/codiumai-diagram-v5.png)
+![PR-Agent Tools](https://codium.ai/images/pr_agent/diagram-v0.9.png)
 
 Check out the [PR Compression strategy](./PR_COMPRESSION.md) page for more details on how we convert a code diff to a manageable LLM prompt
 
@@ -220,9 +225,12 @@ See the [Release notes](./RELEASE_NOTES.md) for updates on the latest changes.
 
 ## Data Privacy
 
-If you use self-host PR-Agent, e.g. via CLI running on your computer, with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here:
+If you use a self-hosted PR-Agent with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here:
 https://openai.com/enterprise-privacy
 
+When using a PR-Agent app hosted by CodiumAI, we will not store any of your data, nor will we used it for training.
+You will also benefit from an OpenAI account with zero data retention.
+
 ## Links
 
 [![Join our Discord community](https://raw.githubusercontent.com/Codium-ai/codiumai-vscode-release/main/media/docs/Joincommunity.png)](https://discord.gg/kG35uSHDBc)

docs/ADD_DOCUMENTATION.md

@@ -7,8 +7,8 @@ It can be invoked manually by commenting on any PR:
 ```
 For example:
 
-<kbd><img src=./../pics/add_docs_comment.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/add_docs_comment.png width="768"></kbd>
-<kbd><img src=./../pics/add_docs.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/add_docs.png width="768"></kbd>
 
 ### Configuration options
  - `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`.

docs/ASK.md

@@ -7,5 +7,5 @@ It can be invoked manually by commenting on any PR:
 ```
 For example:
 
-<kbd><img src=./../pics/ask_comment.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/ask_comment.png width="768"></kbd>
-<kbd><img src=./../pics/ask.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/ask.png width="768"></kbd>

docs/DESCRIBE.md

@@ -7,9 +7,9 @@ It can be invoked manually by commenting on any PR:
 ```
 For example:
 
-<kbd><img src=./../pics/describe_comment.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/describe_comment.png width="768"></kbd>
 
-<kbd><img src=./../pics/describe.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/describe.png width="768"></kbd>
 
 The `describe` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action)
 
@@ -52,11 +52,11 @@ The marker `pr_agent:summary` will be replaced with the PR summary, and `pr_agen
           pr_description.use_description_markers: 'true'
 ```          
 
-<kbd><img src=./../pics/describe_markers_before.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/describe_markers_before.png width="768"></kbd>
 
 ==>
 
-<kbd><img src=./../pics/describe_markers_after.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/describe_markers_after.png width="768"></kbd>
 
 ##### Configuration params:
 

docs/GENERATE_CUSTOM_LABELS.md

@@ -9,10 +9,10 @@ For example:
 
 If we wish to add detect changes to SQL queries in a given PR, we can add the following custom label along with its description:
 
-<kbd><img src=./../pics/custom_labels_list.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/custom_labels_list.png width="768"></kbd>
 
 When running the `generate_labels` tool on a PR that includes changes in SQL queries, it will automatically suggest the custom label:
-<kbd><img src=./../pics/custom_label_published.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/custom_label_published.png width="768"></kbd>
 
 ### How to enable custom labels
 

docs/IMPROVE.md

@@ -7,8 +7,8 @@ It can be invoked manually by commenting on any PR:
 ```
 For example:
 
-<kbd><img src=./../pics/improve_comment.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/improve_comment.png width="768"></kbd>
-<kbd><img src=./../pics/improve.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/improve.png width="768"></kbd>
 
 The `improve` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action)
 
@@ -42,7 +42,7 @@ For example:
 
 `/improve --pr_code_suggestions.summarize=true`
 
-<kbd><img src=./../pics/improved_summerize_open.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/improved_summerize_open.png width="768"></kbd>
 
 ___
 

docs/REVIEW.md

@@ -7,8 +7,8 @@ It can be invoked manually by commenting on any PR:
 ```
 For example:
 
-<kbd><img src=./../pics/review_comment.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/review_comment.png width="768"></kbd>
-<kbd><img src=./../pics/review.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/review.png width="768"></kbd>
 
 The `review` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action)
 
@@ -40,7 +40,7 @@ For an incremental review, which only considers changes since the last PR-Agent
 ```
 Note that the incremental mode is only available for GitHub.
 
-<kbd><img src=./../pics/incremental_review.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/incremental_review.png width="768"></kbd>
 
 Under the section 'pr_reviewer', the [configuration file](./../pr_agent/settings/configuration.toml#L16) contains options to customize the 'review -i' tool.  
 These configurations can be used to control the rate at which the incremental review tool will create new review comments when invoked automatically, to prevent making too much noise in the PR.
@@ -63,9 +63,9 @@ By invoking:
 ```
 The tool will first ask the author questions about the PR, and will guide the review based on his answers.
 
-<kbd><img src=./../pics/reflection_questions.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/reflection_questions.png width="768"></kbd>
-<kbd><img src=./../pics/reflection_answers.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/reflection_answers.png width="768"></kbd>
-<kbd><img src=./../pics/reflection_insights.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/reflection_insights.png width="768"></kbd>
 
 
 #### A note on code suggestions quality

docs/SIMILAR_ISSUE.md

@@ -6,9 +6,9 @@ It can be invoked manually by commenting on any PR:
 ```
 For example:
 
-<kbd><img src=./../pics/similar_issue_original_issue.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/similar_issue_original_issue.png width="768"></kbd>
-<kbd><img src=./../pics/similar_issue_comment.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/similar_issue_comment.png width="768"></kbd>
-<kbd><img src=./../pics/similar_issue.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/similar_issue.png width="768"></kbd>
 
 Note that to perform retrieval, the `similar_issue` tool indexes all the repo previous issues (once).
 

docs/UPDATE_CHANGELOG.md

@@ -7,8 +7,8 @@ It can be invoked manually by commenting on any PR:
 ```
 For example:
 
-<kbd><img src=./../pics/update_changelog_comment.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/update_changelog_comment.png width="768"></kbd>
-<kbd><img src=./../pics/update_changelog.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/update_changelog.png width="768"></kbd>
 
 
 ### Configuration options