From de9b21d7bd11e408dff24e9c8fef091aa7da7be8 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Tue, 18 Jun 2024 09:29:32 +0300 Subject: [PATCH] mkdocs --- docs/docs/css/custom.css | 17 ++++++++--- docs/docs/overview/data_privacy.md | 19 +++++++++++++ docs/docs/{ => overview}/index.md | 45 +----------------------------- docs/docs/overview/pr_agent_pro.md | 20 +++++++++++++ docs/docs/tools/similar_issues.md | 2 +- docs/mkdocs.yml | 28 +++++++++++-------- 6 files changed, 70 insertions(+), 61 deletions(-) create mode 100644 docs/docs/overview/data_privacy.md rename docs/docs/{ => overview}/index.md (68%) create mode 100644 docs/docs/overview/pr_agent_pro.md diff --git a/docs/docs/css/custom.css b/docs/docs/css/custom.css index 8b0879a0..9df64644 100644 --- a/docs/docs/css/custom.css +++ b/docs/docs/css/custom.css @@ -4,16 +4,25 @@ --md-primary-fg-color: #765bfa; --md-accent-fg-color: #AEA1F1; } -.md-nav__title, .md-nav__link { - font-size: 16px; + +.md-nav--primary { + .md-nav__link { + font-size: 18px; /* Change the font size as per your preference */ + } } +/*.md-nav__title, .md-nav__link {*/ +/* font-size: 18px;*/ +/* margin-top: 14px; !* Adjust the space as needed *!*/ +/* margin-bottom: 14px; !* Adjust the space as needed *!*/ +/*}*/ + .md-tabs__link { - font-size: 16px; + font-size: 18px; } .md-header__title { - font-size: 20px; + font-size: 20px; margin-left: 0px !important; } diff --git a/docs/docs/overview/data_privacy.md b/docs/docs/overview/data_privacy.md new file mode 100644 index 00000000..81ced254 --- /dev/null +++ b/docs/docs/overview/data_privacy.md @@ -0,0 +1,19 @@ +## Data Privacy + +### Self-hosted PR-Agent + +- If you host 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 + +## PR-Agent Pro 💎 + +- When using PR-Agent Pro 💎, hosted by CodiumAI, we will not store any of your data, nor will we use it for training. You will also benefit from an OpenAI account with zero data retention. + +- For certain clients, CodiumAI-hosted PR-Agent Pro will use CodiumAI’s proprietary models — if this is the case, you will be notified. + +- No passive collection of Code and Pull Requests’ data — PR-Agent will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request. + + +### PR-Agent Chrome extension + +- The [PR-Agent Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) serves solely to modify the visual appearance of a GitHub PR screen. It does not transmit any user's repo or pull request code. Code is only sent for processing when a user submits a GitHub comment that activates a PR-Agent tool, in accordance with the standard privacy policy of PR-Agent. \ No newline at end of file diff --git a/docs/docs/index.md b/docs/docs/overview/index.md similarity index 68% rename from docs/docs/index.md rename to docs/docs/overview/index.md index a131bd51..26705e37 100644 --- a/docs/docs/index.md +++ b/docs/docs/overview/index.md @@ -78,47 +78,4 @@ The following diagram illustrates PR-Agent tools and their flow: ![PR-Agent Tools](https://codium.ai/images/pr_agent/diagram-v0.9.png) -Check out the [PR Compression strategy](core-abilities/index.md) page for more details on how we convert a code diff to a manageable LLM prompt - - - -## PR-Agent Pro 💎 - -[PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and provides the following benefits: - -1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Agent app to your GitHub\GitLab\BitBucket repo. -2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention. -3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities. -4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. It has the following additional tools and features: - - (Tool): [**Analyze PR components**](./tools/analyze.md/) - - (Tool): [**Custom Prompt Suggestions**](./tools/custom_prompt.md/) - - (Tool): [**Tests**](./tools/test.md/) - - (Tool): [**PR documentation**](./tools/documentation.md/) - - (Tool): [**Improve Component**](https://pr-agent-docs.codium.ai/tools/improve_component/) - - (Tool): [**Similar code search**](https://pr-agent-docs.codium.ai/tools/similar_code/) - - (Tool): [**CI feedback**](./tools/ci_feedback.md/) - - (Feature): [**Interactive triggering**](./usage-guide/automations_and_usage.md/#interactive-triggering) - - (Feature): [**SOC2 compliance check**](./tools/review.md/#soc2-ticket-compliance) - - (Feature): [**Custom labels**](./tools/describe.md/#handle-custom-labels-from-the-repos-labels-page) - - (Feature): [**Global and wiki configuration**](./usage-guide/configuration_options.md/#wiki-configuration-file) - - (Feature): [**Inline file summary**](https://pr-agent-docs.codium.ai/tools/describe/#inline-file-summary) - - -## Data Privacy - -### Self-hosted PR-Agent - -- If you host 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 - -### CodiumAI-hosted PR-Agent Pro 💎 - -- When using PR-Agent Pro 💎, hosted by CodiumAI, we will not store any of your data, nor will we use it for training. You will also benefit from an OpenAI account with zero data retention. - -- For certain clients, CodiumAI-hosted PR-Agent Pro will use CodiumAI’s proprietary models — if this is the case, you will be notified. - -- No passive collection of Code and Pull Requests’ data — PR-Agent will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request. - -### PR-Agent Chrome extension - -- The [PR-Agent Chrome extension](https://chromewebstore.google.com/detail/pr-agent-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) serves solely to modify the visual appearance of a GitHub PR screen. It does not transmit any user's repo or pull request code. Code is only sent for processing when a user submits a GitHub comment that activates a PR-Agent tool, in accordance with the standard privacy policy of PR-Agent. \ No newline at end of file +Check out the [PR Compression strategy](core-abilities/index.md) page for more details on how we convert a code diff to a manageable LLM prompt \ No newline at end of file diff --git a/docs/docs/overview/pr_agent_pro.md b/docs/docs/overview/pr_agent_pro.md new file mode 100644 index 00000000..be0c4dac --- /dev/null +++ b/docs/docs/overview/pr_agent_pro.md @@ -0,0 +1,20 @@ +## PR-Agent Pro 💎 + +[PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and provides the following benefits: + +1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Agent app to your GitHub\GitLab\BitBucket repo. +2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention. +3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities. +4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. It has the following additional tools and features: + - (Tool): [**Analyze PR components**](./tools/analyze.md/) + - (Tool): [**Custom Prompt Suggestions**](./tools/custom_prompt.md/) + - (Tool): [**Tests**](./tools/test.md/) + - (Tool): [**PR documentation**](./tools/documentation.md/) + - (Tool): [**Improve Component**](https://pr-agent-docs.codium.ai/tools/improve_component/) + - (Tool): [**Similar code search**](https://pr-agent-docs.codium.ai/tools/similar_code/) + - (Tool): [**CI feedback**](./tools/ci_feedback.md/) + - (Feature): [**Interactive triggering**](./usage-guide/automations_and_usage.md/#interactive-triggering) + - (Feature): [**SOC2 compliance check**](./tools/review.md/#soc2-ticket-compliance) + - (Feature): [**Custom labels**](./tools/describe.md/#handle-custom-labels-from-the-repos-labels-page) + - (Feature): [**Global and wiki configuration**](./usage-guide/configuration_options.md/#wiki-configuration-file) + - (Feature): [**Inline file summary**](https://pr-agent-docs.codium.ai/tools/describe/#inline-file-summary) \ No newline at end of file diff --git a/docs/docs/tools/similar_issues.md b/docs/docs/tools/similar_issues.md index b73adc64..4f0351e0 100644 --- a/docs/docs/tools/similar_issues.md +++ b/docs/docs/tools/similar_issues.md @@ -33,7 +33,7 @@ environment = "..." These parameters can be obtained by registering to [Pinecone](https://app.pinecone.io/?sessionType=signup/). -## How to use: +## How to use - To invoke the 'similar issue' tool from **CLI**, run: `python3 cli.py --issue_url=... similar_issue` diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 01d8ce65..b5978b9f 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,10 +1,13 @@ -site_name: PR-Agent Documentation +site_name: PR-Agent Documentation repo_url: https://github.com/Codium-ai/pr-agent repo_name: Codium-ai/pr-agent -nav: - - Overview: 'index.md' - - Installation: +nav: + - Overview: + - 'overview/index.md' + - 💎 PR-Agent Pro: 'overview/pr_agent_pro.md' + - Data Privacy: 'overview/data_privacy.md' + - Installation: - 'installation/index.md' - Locally: 'installation/locally.md' - GitHub: 'installation/github.md' @@ -12,14 +15,14 @@ nav: - BitBucket: 'installation/bitbucket.md' - Azure DevOps: 'installation/azure.md' - 💎 PR-Agent Pro: 'installation/pr_agent_pro.md' - - Usage Guide: + - Usage Guide: - 'usage-guide/index.md' - Introduction: 'usage-guide/introduction.md' - Configuration Options: 'usage-guide/configuration_options.md' - Managing Mail Notifications: 'usage-guide/mail_notifications.md' - Usage and Automation: 'usage-guide/automations_and_usage.md' - Additional Configurations: 'usage-guide/additional_configurations.md' - - Tools: + - Tools: - 'tools/index.md' - Describe: 'tools/describe.md' - Review: 'tools/review.md' @@ -59,9 +62,10 @@ theme: - content.code.annotation - content.code.copy - toc.integrate + - content.tabs.link language: en custom_dir: overrides - + palette: - media: "(prefers-color-scheme)" toggle: @@ -70,15 +74,15 @@ theme: - media: "(prefers-color-scheme: light)" scheme: default toggle: - icon: material/toggle-switch-off-outline + icon: material/toggle-switch-off-outline name: Switch to dark mode primary: custom accent: custom - media: "(prefers-color-scheme: dark)" - scheme: slate + scheme: slate toggle: icon: material/toggle-switch - name: Switch to light mode + name: Switch to light mode primary: custom accent: custom @@ -128,8 +132,8 @@ markdown_extensions: emoji_generator: !!python/name:material.extensions.emoji.to_svg - toc: title: On this page - toc_depth: 3 + toc_depth: 2 permalink: true - + - attr_list copyright: | © 2024 CodiumAI