From 8f11a19c32aebaffc06c1e7cf168e22aa51c6c6f Mon Sep 17 00:00:00 2001 From: mrT23 Date: Thu, 18 Jul 2024 09:55:57 +0300 Subject: [PATCH] docs --- docs/docs/css/custom.css | 13 +++++++++++++ docs/docs/installation/bitbucket.md | 4 ++-- docs/docs/usage-guide/automations_and_usage.md | 10 ++++++++++ docs/docs/usage-guide/index.md | 5 +++-- docs/docs/usage-guide/introduction.md | 9 ++------- docs/mkdocs.yml | 4 ++-- 6 files changed, 32 insertions(+), 13 deletions(-) diff --git a/docs/docs/css/custom.css b/docs/docs/css/custom.css index 9df64644..d20f86c4 100644 --- a/docs/docs/css/custom.css +++ b/docs/docs/css/custom.css @@ -11,6 +11,19 @@ } } +.md-nav--primary { + position: relative; /* Ensure the element is positioned */ +} + +.md-nav--primary::before { + content: ""; + position: absolute; + top: 0; + right: 10px; /* Move the border 5 pixels to the left */ + width: 2px; + height: 100%; + background-color: #f5f5f5; /* Match the border color */ +} /*.md-nav__title, .md-nav__link {*/ /* font-size: 18px;*/ /* margin-top: 14px; !* Adjust the space as needed *!*/ diff --git a/docs/docs/installation/bitbucket.md b/docs/docs/installation/bitbucket.md index d3c93ad9..9023399b 100644 --- a/docs/docs/installation/bitbucket.md +++ b/docs/docs/installation/bitbucket.md @@ -27,9 +27,9 @@ You can get a Bitbucket token for your repository by following Repository Settin Note that comments on a PR are not supported in Bitbucket Pipeline. -## Run using CodiumAI-hosted Bitbucket app +## Run using CodiumAI-hosted Bitbucket app 💎 -Please contact [support@codium.ai](mailto:support@codium.ai) or visit [CodiumAI pricing page](https://www.codium.ai/pricing/) if you're interested in a hosted BitBucket app solution that provides full functionality including PR reviews and comment handling. It's based on the [bitbucket_app.py](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/git_providers/bitbucket_provider.py) implementation. +Please contact visit [PR-Agent pro](https://www.codium.ai/pricing/) if you're interested in a hosted BitBucket app solution that provides full functionality including PR reviews and comment handling. It's based on the [bitbucket_app.py](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/git_providers/bitbucket_provider.py) implementation. ## Bitbucket Server and Data Center diff --git a/docs/docs/usage-guide/automations_and_usage.md b/docs/docs/usage-guide/automations_and_usage.md index 96545e1a..3bd5fce0 100644 --- a/docs/docs/usage-guide/automations_and_usage.md +++ b/docs/docs/usage-guide/automations_and_usage.md @@ -26,6 +26,16 @@ verbosity_level=2 ``` This is useful for debugging or experimenting with different tools. +(3) + +**git provider**: The [git_provider](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L5) field in a configuration file determines the GIT provider that will be used by PR-Agent. Currently, the following providers are supported: +` +"github", "gitlab", "bitbucket", "azure", "codecommit", "local", "gerrit" +` + +Default is "github". + + ### Online usage diff --git a/docs/docs/usage-guide/index.md b/docs/docs/usage-guide/index.md index 50fa6de1..8304aded 100644 --- a/docs/docs/usage-guide/index.md +++ b/docs/docs/usage-guide/index.md @@ -1,10 +1,11 @@ # Usage guide -This page provides a detailed guide on how to use PR-Agent. It includes information on how to adjust PR-Agent configurations, define which tools will run automatically, manage mail notifications, and other advanced configurations. +This page provides a detailed guide on how to use PR-Agent. +It includes information on how to adjust PR-Agent configurations, define which tools will run automatically, and other advanced configurations. - [Introduction](./introduction.md) -- [Configuration Options](./configuration_options.md) +- [Configuration File](./configuration_options.md) - [Usage and Automation](./automations_and_usage.md) - [Local Repo (CLI)](./automations_and_usage.md#local-repo-cli) - [Online Usage](./automations_and_usage.md#online-usage) diff --git a/docs/docs/usage-guide/introduction.md b/docs/docs/usage-guide/introduction.md index 74f7a64f..29691cca 100644 --- a/docs/docs/usage-guide/introduction.md +++ b/docs/docs/usage-guide/introduction.md @@ -7,12 +7,7 @@ After [installation](https://pr-agent-docs.codium.ai/installation/), there are t Specifically, CLI commands can be issued by invoking a pre-built [docker image](https://pr-agent-docs.codium.ai/installation/locally/#using-docker-image), or by invoking a [locally cloned repo](https://pr-agent-docs.codium.ai/installation/locally/#run-from-source). -For online usage, you will need to setup either a [GitHub App](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app), or a [GitHub Action](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-action). -GitHub App and GitHub Action also enable to run PR-Agent specific tool automatically when a new PR is opened. - -**git provider**: The [git_provider](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L5) field in the configuration file determines the GIT provider that will be used by PR-Agent. Currently, the following providers are supported: -` -"github", "gitlab", "bitbucket", "azure", "codecommit", "local", "gerrit" -` +For online usage, you will need to setup either a [GitHub App](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app) or a [GitHub Action](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-action) (GitHub), a [GitLab webhook](https://pr-agent-docs.codium.ai/installation/gitlab/#run-a-gitlab-webhook-server) (GitLub), or a [BitBucket App](https://pr-agent-docs.codium.ai/installation/bitbucket/#run-using-codiumai-hosted-bitbucket-app) (BitBucket). +These platforms also enable to run PR-Agent specific tools automatically when a new PR is opened, or on each push to a branch. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index b40c4d10..cf34d800 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -18,9 +18,9 @@ nav: - 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' + - Configuration File: 'usage-guide/configuration_options.md' - Usage and Automation: 'usage-guide/automations_and_usage.md' + - Managing Mail Notifications: 'usage-guide/mail_notifications.md' - Additional Configurations: 'usage-guide/additional_configurations.md' - Tools: - 'tools/index.md'