diff --git a/docs/configuring.md b/docs/configuring.md index 084eda6..8073556 100644 --- a/docs/configuring.md +++ b/docs/configuring.md @@ -14,20 +14,6 @@ Users may set Pixee preferences at either the organization or repository levels. 2. **Organization-wide preferences:** Alternatively, you can create the `pixeebot.yaml` file in the `.github` directory of your `.github` repository. This will serve as the global preferences that apply to all repositories in this installation. -## Codemod catalogs - -Pixee offers three codemod catalogs to choose from in order to tune the type of improvements received. - -- **Less**: Pixee will only suggest improvements for findings identified by a third-party security tool. See the [third-party security tools](/code-scanning-tools/overview) page for more information. -- **Moderate**: In addition to third-party security tool findings, Pixee will also suggest fixes for its own security findings. -- **More**: Includes everything from the Less and Moderate catalogs, along with additional suggestions Pixee identifies, such as style improvements and best practices. - -### Selecting a catalog - -During the onboarding process, users will be given the option to select a catalog preference for the organization they are installing on. This will determine the default catalog used for any repositories in that organization. If this step is skipped and no preference is selected, the Moderate catalog will be used by default. At any time, changes can be made by visiting the Pixee dashboard and selecting "View / change default preference" in the User menu. - -Additionally, the catalog value can be configured on a per-repository/per-organization basis by updating the YAML configuration file. See the [Properties](#properties) section below for more information. - ## Properties ### `ai` @@ -52,18 +38,6 @@ ai: Contains optional preferences related to the codemod catalog Pixee uses to make changes to repositories. -#### `catalog` - -A string value that determines the codemod catalog used for code improvements. -The value can be set to `less`, `moderate`, or `more`. - -Example: - -```yaml -codemods: - catalog: more -``` - #### `exclude` A set of codemods to exclude from the catalog. Each codemod is identified by its diff --git a/docs/installing.md b/docs/installing.md index 40b1970..66879dd 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -19,7 +19,9 @@ Also [contact us](https://pixee.ai/demo-landing-page) if you want to partner as ## Tool connections -Pixee can provide fixes "out of the box" for Java and Python repositories. But you'll get the most value out of Pixee by [connecting it to your existing code scanning tools and services](/code-scanning-tools/overview). This will allow Pixee to provide more accurate and relevant fixes for your codebase. +Pixee fixes problems detected by [your existing code scanning tools and +services](/code-scanning-tools/overview). Therefore, you will need to connect +Pixee to your code scanning tools and services, before Pixee sends fixes. ## Repository access diff --git a/docs/languages.md b/docs/languages.md index 69cd0db..822143a 100644 --- a/docs/languages.md +++ b/docs/languages.md @@ -4,8 +4,6 @@ sidebar_position: 3 # Language support -Pixee can fix issues in Java and Python repositories "out of the box" without a code scanner integration. But, you'll get the most value out of Pixee by connecting it to your existing code scanning tools. This will allow Pixee to provide more accurate and relevant fixes for your codebase and to triage findings from those tools. - When triaging and fixing issues detected by code scanning tools, Pixee supports the following languages: - Java diff --git a/docs/using-pixeebot.md b/docs/using-pixeebot.md index f52e6f9..7ea9dcf 100644 --- a/docs/using-pixeebot.md +++ b/docs/using-pixeebot.md @@ -6,7 +6,7 @@ sidebar_position: 6 ## Continuous improvement -Once installed, Pixee will begin opening pull requests against your repositories immediately. There is no need to summon Pixee manually - all of your improvements will come automatically at a manageable weekly cadence. +After installing Pixee and connecting it to your code scanning services, Pixee will begin opening pull requests against your repositories. There is no need to summon Pixee manually - all of your improvements will come automatically at a manageable weekly cadence. ## Summoning Pixee