# Aviator Documentation

## Aviator Documentation

- [Introduction](https://docs.aviator.co/readme.md): Building blocks for shipping AI-generated code quickly and reliably.
- [Inbox](https://docs.aviator.co/inbox.md): Read documentation for Aviator Inbox, a dashboard for developers to manage pull request reviews and track code review workflows from GitHub.
- [Custom Sections](https://docs.aviator.co/inbox/custom-sections.md): Learn how to create custom sections in Aviator Inbox to organize pull requests with personalized filters based on authors, labels, repositories, and more.
- [Inbox Best Practices](https://docs.aviator.co/inbox/best-practices.md): Check out best practices for Inbox to learn standard operating principles for maximum benefits on developer productivity.
- [How to Manually Change Attention](https://docs.aviator.co/inbox/manually-change-attention.md): Learn how to manually add or remove attention on a PR in Inbox. Get detailed instructions and examples on using the Aviator dashboard.
- [Attention Reasons](https://docs.aviator.co/inbox/attention-reasons.md): Understand the reasons for attention assignment in Inbox: code review assignment, reviewer comments, PR approval, required status check failures, and more.
- [Inbox Chrome Extension](https://docs.aviator.co/inbox/attentionset-chrome-extension.md): Access the Aviator AttentionSet Chrome extension and learn how it works. See PRs waiting for your review, indicated by the orange flag on GitHub's PR list view.
- [Inbox Slack Home Page](https://docs.aviator.co/inbox/attentionset-slack-home-page.md): Access the Aviator AttentionSet in Slack. See PRs waiting for your review, and the review status of your PRs.
- [Runbooks](https://docs.aviator.co/runbooks.md)
- [Getting started](https://docs.aviator.co/runbooks/getting-started.md)
- [Concepts](https://docs.aviator.co/runbooks/concepts.md)
- [Architecture Overview](https://docs.aviator.co/runbooks/concepts/architecture-overview.md)
- [Runbook Format](https://docs.aviator.co/runbooks/concepts/runbook-format.md)
- [Templates](https://docs.aviator.co/runbooks/concepts/templates.md)
- [Personas](https://docs.aviator.co/runbooks/concepts/personas.md)
- [Collaborating with the team](https://docs.aviator.co/runbooks/concepts/collaborating-with-the-team.md)
- [Context and learnings](https://docs.aviator.co/runbooks/concepts/context-and-learnings.md)
- [Working with large codebases](https://docs.aviator.co/runbooks/concepts/working-with-large-codebases.md)
- [One shot mode](https://docs.aviator.co/runbooks/concepts/one-shot-mode.md)
- [Cloud sandboxes](https://docs.aviator.co/runbooks/concepts/cloud-sandboxes.md)
- [SSH sandboxes](https://docs.aviator.co/runbooks/concepts/ssh-sandboxes.md)
- [Use Cases](https://docs.aviator.co/runbooks/concepts/use-cases.md): Take a look at some common use cases with examples.
- [Product backlog](https://docs.aviator.co/runbooks/concepts/use-cases/product-backlog.md)
- [Code refactoring](https://docs.aviator.co/runbooks/concepts/use-cases/code-refactoring.md)
- [Bug fixes](https://docs.aviator.co/runbooks/concepts/use-cases/bug-fixes.md)
- [Code migrations](https://docs.aviator.co/runbooks/concepts/use-cases/code-migrations.md)
- [Improving code coverage](https://docs.aviator.co/runbooks/concepts/use-cases/improving-code-coverage.md)
- [Improving readability](https://docs.aviator.co/runbooks/concepts/use-cases/improving-readability.md)
- [Flaky test resolution](https://docs.aviator.co/runbooks/concepts/use-cases/flaky-test-resolution.md)
- [Improve build times](https://docs.aviator.co/runbooks/concepts/use-cases/improve-build-times.md)
- [How to guides](https://docs.aviator.co/runbooks/how-to-guides.md)
- [One shot mode](https://docs.aviator.co/runbooks/how-to-guides/one-shot-mode.md)
- [Editing Runbooks](https://docs.aviator.co/runbooks/how-to-guides/editing-runbooks.md)
- [PR Lifecycle management](https://docs.aviator.co/runbooks/how-to-guides/pr-lifecycle-management.md)
- [Step-by-step execution](https://docs.aviator.co/runbooks/how-to-guides/step-by-step-execution.md)
- [Managing Templates](https://docs.aviator.co/runbooks/how-to-guides/managing-templates.md)
- [Persona management](https://docs.aviator.co/runbooks/how-to-guides/persona-management.md)
- [Context management](https://docs.aviator.co/runbooks/how-to-guides/context-management.md)
- [Claude Code tool permissions](https://docs.aviator.co/runbooks/how-to-guides/claude-code-tools.md)
- [MCP servers](https://docs.aviator.co/runbooks/how-to-guides/mcp-servers.md)
- [Best practices for planning](https://docs.aviator.co/runbooks/how-to-guides/best-practices-for-planning.md)
- [Batch Operations with Runbook Templates](https://docs.aviator.co/runbooks/how-to-guides/batch-operations-with-runbook-templates.md)
- [Pre-Execution Scripts](https://docs.aviator.co/runbooks/how-to-guides/pre-execution-scripts.md)
- [Using Stacked PRs](https://docs.aviator.co/runbooks/how-to-guides/using-stacked-prs.md)
- [Providing feedback](https://docs.aviator.co/runbooks/how-to-guides/providing-feedback.md)
- [Handling CI failure](https://docs.aviator.co/runbooks/how-to-guides/handling-ci-failure.md)
- [SSH Sandboxes Configuration Guide](https://docs.aviator.co/runbooks/how-to-guides/ssh-sandboxes-configuration-guide.md)
- [SSH Sandboxes setup for onprem](https://docs.aviator.co/runbooks/how-to-guides/ssh-sandboxes-setup-for-onprem.md)
- [FAQ & Troubleshooting](https://docs.aviator.co/runbooks/faq-and-troubleshooting.md)
- [API Reference for Runbooks](https://docs.aviator.co/runbooks/api-reference.md): This reference page describes the usage of REST API for Runbooks. Get instructions on how to create a runbook, check its status, and more.
- [Verify](https://docs.aviator.co/verify.md)
- [How it works](https://docs.aviator.co/verify/how-it-works.md)
- [Your first verification](https://docs.aviator.co/verify/your-first-spec.md)
- [Setting up org invariants](https://docs.aviator.co/verify/setting-up-org-invariants.md)
- [Concepts](https://docs.aviator.co/verify/concepts.md)
- [Why intent-driven verification](https://docs.aviator.co/verify/concepts/why-intent-driven-verification.md)
- [Verification layers](https://docs.aviator.co/verify/concepts/verification-layers.md)
- [How verification works](https://docs.aviator.co/verify/concepts/how-verification-works.md)
- [Invariants](https://docs.aviator.co/verify/concepts/invariants.md)
- [Previews](https://docs.aviator.co/verify/concepts/previews.md)
- [Audit trails and compliance](https://docs.aviator.co/verify/concepts/audit-trails-and-compliance.md)
- [Reference](https://docs.aviator.co/verify/reference.md)
- [MCP tools](https://docs.aviator.co/verify/reference/mcp-tools.md)
- [Spec format](https://docs.aviator.co/verify/reference/spec-format.md)
- [Preview YAML](https://docs.aviator.co/verify/reference/preview-yaml.md)
- [Understanding verification results](https://docs.aviator.co/verify/reference/understanding-verification-results.md)
- [GitHub integration](https://docs.aviator.co/verify/reference/github-integration.md)
- [Configuration reference](https://docs.aviator.co/verify/reference/configuration-reference.md): Configuration surface for Verify — per-repo verify.yaml and org-level settings.
- [How to guides](https://docs.aviator.co/verify/how-to-guides.md)
- [Connect a repository](https://docs.aviator.co/verify/how-to-guides/connect-a-repository.md)
- [Writing effective acceptance criteria](https://docs.aviator.co/verify/how-to-guides/writing-effective-acceptance-criteria.md)
- [Writing a SKILL.md](https://docs.aviator.co/verify/how-to-guides/writing-a-skill-md.md)
- [Creating a preview](https://docs.aviator.co/verify/how-to-guides/creating-a-preview.md)
- [Managing previews](https://docs.aviator.co/verify/how-to-guides/managing-previews.md)
- [Seed data for previews](https://docs.aviator.co/verify/how-to-guides/seed-data-for-previews.md)
- [Running with remote agents](https://docs.aviator.co/verify/how-to-guides/running-with-remote-agents.md)
- [Configuring branch protection](https://docs.aviator.co/verify/how-to-guides/configuring-branch-protection.md)
- [Fixing verification failures](https://docs.aviator.co/verify/how-to-guides/fixing-verification-failures.md)
- [Export audit logs](https://docs.aviator.co/verify/how-to-guides/export-audit-logs.md)
- [Releases](https://docs.aviator.co/releases-beta.md): Documentation for Aviator Releases, a dashboard that helps engineering teams manage deployments across environments in a central dashboard.
- [Getting Started with Releases](https://docs.aviator.co/releases-beta/getting-started.md): How to get started with Aviator Releases Releases. This page guides you to setting up Aviator Releases using GitHub actions step by step.
- [Concepts for Releases](https://docs.aviator.co/releases-beta/concepts.md): Learn about core concepts for the Releases dashboard, including terminology, two-step delivery, rollbacks, cherry-picks, dogfood, canary and rollout, and other.
- [Terminology for Releases](https://docs.aviator.co/releases-beta/concepts/terminology.md): Read the terminology for the Releases feature. The common terms are important to understand the Release process with Aviator and use the tool more effectively.
- [Two-step delivery](https://docs.aviator.co/releases-beta/concepts/two-step-delivery.md): Find out how two-step delivery works with Releases. We recommend splitting the delivery in two steps when you use trunk based development and Aviator Releases.
- [Rollbacks](https://docs.aviator.co/releases-beta/concepts/rollbacks.md): Learn about the rollback feature in Releases. Rollbacks enable you to revert to a previous stable version when a newly deployed version has issues.
- [Cherry-picks](https://docs.aviator.co/releases-beta/concepts/cherry-picks.md): Read about the cherry-picks feature in Releases. Aviator enables teams to cherry-pick the same commit or pull request to multiple releases in one action.
- [Dogfood, Canary and Rollout](https://docs.aviator.co/releases-beta/concepts/dogfood-canary-and-rollout.md): Check out deployment strategies that limit the impact in case of a failure during deployment. Dogfood, Canary, and Rollout explained with usage guidelines.
- [Release notes](https://docs.aviator.co/releases-beta/concepts/release-notes.md): Read the concepts behind release notes from Aviator Releases. Helpful for internal teams, QA, support, for a shared understanding of recent code changes.
- [How-to Guides for Releases](https://docs.aviator.co/releases-beta/how-to-guides.md): Access all how-to guides for Releases from this page. Get instructions on creating a release project, configuring environments, and other key operations.
- [How to Create a Release Project](https://docs.aviator.co/releases-beta/how-to-guides/creating-a-release-project.md): Follow our guide for instructions on creating a release project with examples. A Release Project is a top-level entity you must build and deploy simultaneously.
- [How to Configure Environments](https://docs.aviator.co/releases-beta/how-to-guides/configuring-environments.md): Read how to configure requirements in Aviator Releases in our how-to guide. Set up a separate environment for anything that can be uniquely deployed.
- [How to Create a Scheduled Release](https://docs.aviator.co/releases-beta/how-to-guides/create-a-scheduled-release.md): Use our guide for instrutions on how to schedule a release. Set up automated creation of a new version of your software at specific intervals or times.
- [Create Custom Workflow Parameters](https://docs.aviator.co/releases-beta/how-to-guides/create-custom-workflow-parameters.md): Use our guide to create custom workflow parameters. This setting allows you to manage key-value pairs that can be accessed during software build and deployment.
- [How to Manage Cherry-Picks](https://docs.aviator.co/releases-beta/how-to-guides/managing-cherry-picks.md): Visit our guide to get instructions on managing cherry-picks for smooth release. In Aviator, cherry-picks selectively integrate changes into release candidates.
- [How to Resolve a Cherry-Pick Failure](https://docs.aviator.co/releases-beta/how-to-guides/resolving-a-cherry-pick-failure.md): A cherry-picking workflow may fail due to a merge conflict. This document explains how to manage such an issue during a release process in Aviator.
- [Working with your CI / CD](https://docs.aviator.co/releases-beta/how-to-guides/working-with-your-ci-cd.md): Read about the specifics of using Aviator with CI / CD and supported integrations. Aviator Releases works with your existing CI or CD system, not replace one.
- [GitHub Actions workflow](https://docs.aviator.co/releases-beta/how-to-guides/working-with-your-ci-cd/github-actions-workflow.md): Use our guide to set up GitHub Actions build and deploy to manage releases in Aviator. Instructions on authentication, building and deploying workflows.
- [Buildkite workflow](https://docs.aviator.co/releases-beta/how-to-guides/working-with-your-ci-cd/buildkite-workflow.md): Use our guide to set up Buildkite build and deploy steps to manage releases in Aviator. Authentication and Buildkite Webhook configuration instructions.
- [API Reference for Releases](https://docs.aviator.co/releases-beta/api-reference.md): This reference page describes the usage of REST API for Release management. Get instructions on how to create a release, create and update deployment, and more.
- [FlexReview](https://docs.aviator.co/flexreview.md): Learn about Aviator FlexReview, a framework that speeds up code reviews by understanding the nuances of every code change and assigning reviewers.
- [Getting Started with FlexReview](https://docs.aviator.co/flexreview/getting-started.md): Get started with FlexReview easily using our guide. Learn how to connect the Aviator GitHub app to your GitHub repository to use FlexReview and more.
- [How to Onboard a Large Org](https://docs.aviator.co/flexreview/onboarding-a-large-org.md): Get instructions on onboarding a large org. Migrating from the strict controls of the Codeowners concept can enhance maintenance and bring other benefits.
- [Concepts for FlexReview](https://docs.aviator.co/flexreview/concepts.md): Learn more about the core concepts for FlexReview: Read-only mode, Reviewer suggestion and assignment, Approval Requirements, Teams and SLO Management.
- [Read-Only Mode in FlexReview](https://docs.aviator.co/flexreview/concepts/read-only-mode.md): Learn how the read-only more works in FlexReview and get use instructions. This mode allows you to test out FlexReview without interfering with any workflows.
- [Recursive Ownership in FlexReview](https://docs.aviator.co/flexreview/concepts/recursive-ownership.md): Learn how recursive ownership enhances code review workflows by assigning ownership dynamically in FlexReview.
- [Reviewer suggestion and assignment](https://docs.aviator.co/flexreview/concepts/reviewer-suggestion-and-assignment.md): Learn about reviewer suggestions and assignments in FlexReview. Reviewer suggestions reduce code review response time and help improve the developer workflow.
- [FlexReview Teams and SLO Management](https://docs.aviator.co/flexreview/concepts/slo-management.md): Learn more about teams and SLO management in FlexReview. FlexReview Service Level Objective standardizes code review for teams to speed up the process.
- [Validation in FlexReview](https://docs.aviator.co/flexreview/concepts/validation-in-flexreview.md): Validation enhances code reviews by validating the required approvals based on the defined ownership of the code and selectively dismisses reviewers based on code changes.
- [How-to Guides for FlexReview](https://docs.aviator.co/flexreview/how-to-guides.md): Check out how-to guides for the FlexReview low-config tool. Learn how to get a reviewer suggestion, exclude a reviewer, configure team rules, and more.
- [How to Get a Reviewer Suggestion](https://docs.aviator.co/flexreview/how-to-guides/get-reviewer-suggestion.md): Get a reviewer suggestion from FlexReview with the Aviator app installed on your GitHub repository. View suggested reviewers without adding comments to a PR
- [How to Exclude Reviewers](https://docs.aviator.co/flexreview/how-to-guides/excluding-reviewers.md): Learn how to exclude certain reviewers from being suggested. They will be still accepted for approval check validation but are never suggested by FlexReview.
- [How to Set Up Team Rules](https://docs.aviator.co/flexreview/how-to-guides/set-up-team-rules.md): Read how to set up team rules in FlexReview. Get instructions on using Team Dashboard, Review Assignment, setting internal and external review SLOs, and more.
- [Whitelist Teams for Review Assignment](https://docs.aviator.co/flexreview/how-to-guides/whitelist-teams-for-review-assignment.md): Step-by-step guide on whitelisting teams for automatic reviewer assignment in FlexReview.
- [Troubleshoot Reviewer Assignment](https://docs.aviator.co/flexreview/how-to-guides/troubleshoot-reviewer-assignment.md): Find and fix issues with automatic reviewer assignment in FlexReview using this troubleshooting guide.
- [PagerDuty Integration for Reviewers](https://docs.aviator.co/flexreview/how-to-guides/pagerduty-integration-for-reviewers.md): Set up PagerDuty for automated reviewer assignments in FlexReview with this step-by-step guide.
- [How to Set Up FlexReview Validation](https://docs.aviator.co/flexreview/how-to-guides/how-to-set-up-flexreview-validation.md): Learn how to enable FlexReview validation in both Aviator and GitHub.
- [Recommended Slack Notification Settings](https://docs.aviator.co/flexreview/how-to-guides/recommended-slack-notification-settings.md): Get advice on setting up your FlexReview Slack notifications.
- [How to Exclude OOO Reviewers](https://docs.aviator.co/flexreview/how-to-guides/how-to-exclude-ooo-reviewers.md): Learn how to exclude out of office users from being automatically assigned as reviewers.
- [FlexReview Reference](https://docs.aviator.co/flexreview/reference.md): Visit the FlexReview Reference page to get instant access to configuration instructions, slash instructions, and expert scoring algorithms.
- [Configuration](https://docs.aviator.co/flexreview/reference/configuration.md): Configuration guidelines for FlexReview. Core configuration properties that help you modify how FlexReview behaves: Enable / Disable, Approval Check, and more.
- [Slash commands](https://docs.aviator.co/flexreview/reference/flexreview-slash-commands.md): View Slash commands you can use with FlexReview to interact with software tools more efficiently. Suggest and Show Status commands explained with use cases.
- [Expert scoring algorithms](https://docs.aviator.co/flexreview/reference/expert-scoring-algorithms.md): Learn about expert scoring algorithms in FlexReview. Reviewer suggestions and expert review requirements are based on expert scores calculated for every user.
- [Slack Notifications](https://docs.aviator.co/flexreview/reference/slack-notifications.md): Description of FlexReview Slack notification settings
- [Out of Office User Exclusion](https://docs.aviator.co/flexreview/reference/out-of-office-user-exclusion.md): Guide on how to set up and manage OOO exclusions.
- [FlexReview Roadmap](https://docs.aviator.co/flexreview/roadmap.md): Check out the features to be implemented in FlexReview soon and share any requests for future releases.
- [MergeQueue](https://docs.aviator.co/mergequeue.md): Get introduced to MergeQueue to automate merge workflows for GitHub repositories. Documentation on how it works.
- [Getting Started with MergeQueue](https://docs.aviator.co/mergequeue/quick-setup.md): Get started with MergeQueue smoothly using our guide. It's the recommended point to begin your journey. We will walk you through the initial setup steps.
- [Merge Rules](https://docs.aviator.co/mergequeue/configuration-file.md): Learn what merge rules are applied in MergeQueue to use them more efficiently. Rules affect how the Aviator bot reacts to the actions happening on GitHub.
- [How-to Guides for MergeQueue](https://docs.aviator.co/mergequeue/how-to-guides.md): Check out how-to guides for MergeQueue. Learn how to configure dase branches, customize required checks, set up fast-forwarding, and complete other actions.
- [How to Configure Base Branches](https://docs.aviator.co/mergequeue/how-to-guides/configure-base-branches.md): Specify base branches Aviator should monitor, ignoring any PRs that target a different base branch. Learn how to configure base branches using an example here.
- [How to Customize Required Checks](https://docs.aviator.co/mergequeue/how-to-guides/customize-required-checks.md): Learn how to customize required checks in our guide for MergeQueue. Discover several main approaches and use the most suitable and convenient one for your team.
- [How to Set Up Fast-Forwarding](https://docs.aviator.co/mergequeue/how-to-guides/fast-forwarding.md): Learn how to enable fast-forwarding in MergeQueue. Use our guide for detailed instructions, sample configuration, and additional optimization settings.
- [How to Set Up Pre-Queue Conditions](https://docs.aviator.co/mergequeue/how-to-guides/set-up-pre-queue-conditions.md): This guide provides steps to configure pre-queue conditions. Get detailed instructions with screenshots and samples in Aviator Documentation.
- [How to Queue / Dequeue via API](https://docs.aviator.co/mergequeue/how-to-guides/queue-dequeue-via-api.md): You can use a set of Aviator APIs and webhooks to build custom workflows. Get instructions on how to queue / dequeue via API in our manual guide.
- [Pause / Unpause Queues via API](https://docs.aviator.co/mergequeue/how-to-guides/pause-unpause-queues-via-api.md): Get guidelines on how to pause / unpause queues via API for MergeQueue. Pausing allows you to control whether PRs are merged to a specific branch.
- [Slash Commands Using GitHub Comments](https://docs.aviator.co/mergequeue/how-to-guides/slash-commands.md): Learn how to invoke Slash commands using GitHub Comments. Slash commands enable teams to manage pull requests directly from the GitHub pull request page.
- [How to Customize Sticky Comments](https://docs.aviator.co/mergequeue/how-to-guides/customize-sticky-comments.md): Get instructions on customizing sticky comments in Aviator with a configuration example. Sticky comments can provide you with the status of a PR within GitHub.
- [Require an Aviator Status Check](https://docs.aviator.co/mergequeue/how-to-guides/require-an-aviator-status-check.md): Aviator supports a GitHub status check you can enable for PRs or add as a required check-in branch protection rules. Learn how to set up Aviator status checks.
- [Backport a PR](https://docs.aviator.co/mergequeue/how-to-guides/backport-a-pr.md): Get instructions on backporting a PR using the backport slash command or API in our how-to guide. Our concise guidelines speed up configuration tremendously.
- [How to Configure ChangeSets](https://docs.aviator.co/mergequeue/how-to-guides/configuring-changesets.md): Learn how to configure ChangeSets in MergeQueue using our step-by-step guide. With this feature, you can create a list of PRs that need to be merged together.
- [Custom Integrations](https://docs.aviator.co/mergequeue/how-to-guides/custom-integrations.md): Discover custom integrations available for MergeQueue. GitHub integration instructions and other options that can streamline your engineering efforts.
- [GitHub Integration](https://docs.aviator.co/mergequeue/how-to-guides/custom-integrations/slack-integration.md): Use our GitHub integration instructions to connect your GitHub account to Aviator. Go to the Personal Integrations page to connect the necessary account.
- [How to Create Personal Access Tokens](https://docs.aviator.co/mergequeue/how-to-guides/personal-access-tokens.md): Learn how to connect your app using a Personal Developer token instead of using Aviator app authentication when connecting as a GitHub app has limitations.
- [How to Set Up SAML Configuration](https://docs.aviator.co/mergequeue/how-to-guides/saml-configuration.md): Follow our guide to configure SAML configuration. The documentation explains the process of setting up the single sign-on supported across Aviator's accounts.
- [Microsoft Active Directory](https://docs.aviator.co/mergequeue/how-to-guides/saml-configuration/microsoft-active-directory.md): Learn how to set up SAML configuration with Microsoft Active Directory. We provide step-by-step instructions and samples to take you through the process.
- [SCIM Provisioning](https://docs.aviator.co/mergequeue/how-to-guides/saml-configuration/scim-provisioning.md): Configure SCIM 2.0 provisioning so your identity provider (e.g., Okta) can automatically create, update, and deactivate users in Aviator.
- [How to Merge Stacked PRs](https://docs.aviator.co/mergequeue/how-to-guides/merging-stacked-prs.md): Use our how-to guide for instructions on merging stacked PRs. Learn about queueing actions, core merge behaviors for stacked PRs, and separating merge commits.
- [How to Block Pull Request Mergeing with Slash Commands](https://docs.aviator.co/mergequeue/how-to-guides/how-to-block-pull-request-mergeing-with-slash-commands.md): Learn how to block a pull request from merging until certain conditions are met using GitHub slash commands.
- [How to Proactively Dequeue Failing PRs](https://docs.aviator.co/mergequeue/how-to-guides/proactive-dequeue.md): Learn how proactive dequeue identifies and removes failing PRs from the middle of the parallel mode queue without waiting for them to reach the top.
- [Concepts for MergeQueue](https://docs.aviator.co/mergequeue/concepts.md): Learn more about the core concepts for MergeQueue. Queue modes, pull request lifecycle, analytics, parallel mode, CI status requirements, and others.
- [Queue Modes](https://docs.aviator.co/mergequeue/concepts/queue-modes.md): Check the main queue modes MergeQueue can be configured to operate in. Default, parallel, and no queue modes explained with different features and performance.
- [Pull Request Lifecycle](https://docs.aviator.co/mergequeue/concepts/pull-request-lifecycle.md): Learn the main states a pull request can be in MergeQueue. MergeQueue tracks pull requests from the time they are opened until they are merged or closed.
- [Analytics](https://docs.aviator.co/mergequeue/concepts/analytics.md): Check out the analytics metrics you can access on the Analytics page of Aviator and what they mean. Time in Queue, Aviator bot usage, PR failure reasons, etc.
- [Parallel Mode](https://docs.aviator.co/mergequeue/concepts/parallel-mode.md): Learn about parallel mode in MergeQueue, how to configure it, Draft PRs created in this mode by Aviator, CI behaviors, managing parallelism, and other details.
- [CI Status Requirements](https://docs.aviator.co/mergequeue/concepts/ci-status-requirements.md): MergeQueue allows you to add more requirements at different levels. Learn about pre-queue status requirements and draft PR status requirements supported.
- [MQ Created Branches](https://docs.aviator.co/mergequeue/concepts/optimizing-ci-execution.md): Find out when Aviator MergeQueue automatically creates branches and pull requests in our guide. mq-bot-\* branches and draft PRs, mq-tmp-\* branches, and more.
- [Batching](https://docs.aviator.co/mergequeue/concepts/batching.md): Learn the nuances of batching and related FAQs. Batching works alongside Parallel mode to scale the throughput of PRs merged, by merging more PRs per CI run.
- [Managing flaky tests](https://docs.aviator.co/mergequeue/concepts/managing-flaky-tests-in-mergequeue.md): Learn about the flaky test problem in parallel mode and how to manage flaky tests with optimistic validation. Optimistic validation configuration instructions.
- [Fast-forwarding](https://docs.aviator.co/mergequeue/concepts/fast-forwarding.md): With MergeQueue fast-forwarding, Aviator builds parallel speculative pipelines in sequential order, guaranteeing that the default branch is always green.
- [Pre-Queue Conditions](https://docs.aviator.co/mergequeue/concepts/pre-queue-conditions.md): Learn what pre-queue conditions you can set to make a PR meet them before entering a queue. Number of approvals, required GitHub checks, and others.
- [Sticky Comments](https://docs.aviator.co/mergequeue/concepts/sticky-comments.md): Aviator provides sticky comments to show the PR status within GitHub. Check out the core comments that are generated to better understand when you can see them.
- [Backporting](https://docs.aviator.co/mergequeue/concepts/backporting.md): Read how backporting works with Aviator MergeQueue. Backport a particular PR on another base branch to create a new PR that keeps and applies original changes.
- [Paused Queues](https://docs.aviator.co/mergequeue/concepts/paused-queues.md): Read about the paused queues feature and how MergeQueue works when a queue is paused. Pausing a queue allows you to control whether devs can merge PRs.
- [Affected Targets](https://docs.aviator.co/mergequeue/concepts/affected-targets.md): MergeQueue affected targets overview and configuration. Create dynamic queues to combine multi-queue and parallel processing benefits for merging PRs.
- [Directory-Based Affected Targets](https://docs.aviator.co/mergequeue/concepts/affected-targets/directory-based-affected-targets.md): Get setup instructions for automated and manually specified targets. Learn how to manually define targets based on your directory structure in our guide.
- [nx based affected targets](https://docs.aviator.co/mergequeue/concepts/affected-targets/nx-based-affected-targets.md): Read how to configure Nx-based targets in MergeQueue. Nx is a popular build framework for monorepos that identifies the targets that are affected by a change.
- [GitHub Actions based Affected Targets](https://docs.aviator.co/mergequeue/concepts/affected-targets/github-actions-based-affected-targets.md): Learn how to configure GitHub Actions workflows to run only when certain files are changed. MergeQueue can identify the affected targets for the queue.
- [ChangeSets](https://docs.aviator.co/mergequeue/concepts/changesets.md): Read an overview of the ChangeSets feature. It allows you to create a list of PRs to be merged together, which is helpful for merging a large number of PRs.
- [Global CI Validation](https://docs.aviator.co/mergequeue/concepts/changesets/global-ci-validation.md): Discover the Global CI Validation setting in MergeQueue ChangeSets. It enables Aviator to issue webhooks you can use to trigger CI tests for pre-merge checks.
- [ChangeSets FAQs](https://docs.aviator.co/mergequeue/concepts/changesets/faqs.md): Find answers to common questions about the ChangeSets feature that creates a list of PRs to be merged.
- [Priority Merges](https://docs.aviator.co/mergequeue/concepts/priority-merges.md): Find out how the priority merge feature works. When this label is applied to a pull request, Aviator moves it to the front of the queue to be merged first.
- [Instant Merges](https://docs.aviator.co/mergequeue/concepts/priority-merges/instant-merges.md): Read about instant merges, why use instant merge, and how to configure it in our guide. This method merges the PR directly without waiting for the CI to finish.
- [Merge Rules Audit Trail](https://docs.aviator.co/mergequeue/concepts/audit-trail.md): Learn details about how merge rules audit trail works. It allows you to know when your merge rules have been changed, and who changed them for better tracking.
- [Timeline](https://docs.aviator.co/mergequeue/concepts/timeline.md): Read more about the Timeline tool. It allows you to look at all the current and past actions by Aviator and filter activities based on event and base branches.
- [Ready Hook](https://docs.aviator.co/mergequeue/concepts/ready-hook.md): Learn what are ready hooks in MergeQueue and how they work. User-defined ready hooks can execute custom JavaScript code to control MergeQueue behavior.
- [Reduce Queue Failures From Staleness](https://docs.aviator.co/mergequeue/concepts/reducing-queue-failures-due-to-staleness.md): When a code review takes too long, by the time the PR is ready to be merged, the PR may become stale. Get troubleshooting instructions here.
- [MergeQueue References](https://docs.aviator.co/mergequeue/reference.md): Check out helpful references for MergeQueue. Links to configuration schema, configuration reference, GitHub slash dommands, status codes, and more.
- [Configuration Reference MergeQueue](https://docs.aviator.co/mergequeue/reference/complete-reference-guide.md): This page guides you through configuration files and all the possible ways you can customize your MergeQueue experience. Check the main Merge Rules you can use.
- [GitHub Slash Commands](https://docs.aviator.co/mergequeue/reference/slash-commands.md): Discover the GitHub slash commands you can use with Aviator. Merge, cancel, refresh, backport, stack merge, stack cancel, sync, and other core commands.
- [Status Codes](https://docs.aviator.co/mergequeue/reference/status-codes.md): Check out the main status codes you can come across in Aviator. If any issue or failure happens, you will see a status code or its corresponding description.
- [Stacked PRs CLI](https://docs.aviator.co/aviator-cli.md): Get instructions on managing stacked PRs with Aviator's open-source CLI in the Aviator documentation. Create, update, and merge a stack using Aviator.
- [Quickstart for Stacked PRs CLI](https://docs.aviator.co/aviator-cli/quickstart.md): Quickstart guide for Stacked PRs CLI. Learn how to use Aviator CLI to drive day-to-day development. Initialization guidelines, topic branch creation, and more.
- [CLI Installation](https://docs.aviator.co/aviator-cli/installation.md): Learn how to install Stacked PRs CLI. The Aviator command line tool can streamline and automate common tasks within your Git and GitHub workflows.
- [How-to Guides for Stacked PRs CLI](https://docs.aviator.co/aviator-cli/how-to-guides.md): How-to guides when using av CLI from Aviator for StackedPRs.
- [How to Create Stacked PRs in CLI](https://docs.aviator.co/aviator-cli/how-to-guides/creating-stacked-prs.md): Documentation on creating Stacked PRs with av CLI from Aviator.
- [How to Navigate & Modify Stacked PRs](https://docs.aviator.co/aviator-cli/how-to-guides/navigating-and-modifying-stacked-prs.md): Learn how to navigate and modify StackedPRs with av tree when using Aviator's CLI.
- [Add Commits in the Stack](https://docs.aviator.co/aviator-cli/how-to-guides/add-commits-in-the-stack.md): Documentation on adding commits to the stack with av CLI from Aviator.
- [How Split a Commit in CLI](https://docs.aviator.co/aviator-cli/how-to-guides/splitting-a-commit.md): Learn how to split a large commit with Stacked PRs CLI in our guide. Improve code review quality, keep a clean Git history, and improve code velocity.
- [How to Split and Fold Pull Requests](https://docs.aviator.co/aviator-cli/how-to-guides/split-and-fold-pull-requests.md): Learn how to split and fold pull requests in our how-to guide. It's helpful when you accidentally create a large pull request and must split it for code review.
- [How to Rename a Branch in CLI](https://docs.aviator.co/aviator-cli/how-to-guides/rename-a-branch.md): Learn how to rename a branch with av cli from Aviator.
- [How to Adopt a Branch in CLI](https://docs.aviator.co/aviator-cli/how-to-guides/adopt-a-branch.md): Documentation on adopting a branch with av CLI from Aviator with the command av branch.
- [Orphan a Branch with Aviator CLI](https://docs.aviator.co/aviator-cli/how-to-guides/orphan-a-branch.md): Learn how to orphan a branch using Aviator CLI for better version control and repository management.
- [How to Do Git Subcommand Aliasing](https://docs.aviator.co/aviator-cli/how-to-guides/git-subcommand-aliasing.md): How to guide for Git Subcommand Aliasing when using StackedPRs CLI.
- [How to Create an Access Token](https://docs.aviator.co/aviator-cli/how-to-guides/create-a-user-access-token.md): Guide on creating an access token for interacting with GitHub for authentication when using Aviator StackedPRs CLi.
- [How to Set Up Auto Completion in CLI](https://docs.aviator.co/aviator-cli/how-to-guides/setup-auto-completion.md): Set up shell auto completion when using StackedPRs from Aviator.
- [How to Use Editor Plugins in CLI](https://docs.aviator.co/aviator-cli/how-to-guides/use-editor-plugins.md): Learn how to use editor plugins when setting up av CLI from Aviator.
- [Concepts for StackedPRs CLI](https://docs.aviator.co/aviator-cli/concepts.md): Learn more about the branches and stack in Aviator StackedPRs CLI: Trunk branches that PRs are merged into and topic branches that contain proposed changes.
- [How to Rebase and Sync with GitHub](https://docs.aviator.co/aviator-cli/rebasing-and-syncing-with-github.md): Learn how to rebase and sync with GitHub. Aviator CLI fetches the latest commits from the remote, and rebases your branches on top of the new commits.
- [Configuration for StackedPRs CLI](https://docs.aviator.co/aviator-cli/configuration.md): Read documentation to configure Aviator's StackedPRs CLI, also known as av CLI.
- [Stacked PRs FAQs and Troubleshooting](https://docs.aviator.co/aviator-cli/faqs-and-troubleshooting.md): FAQs and troubleshooting for Aviator StackedPRs CLI, av cli.
- [Working with Aviator CLI](https://docs.aviator.co/aviator-cli/faqs-and-troubleshooting/working-with-aviator.md): Aviator Stacked PRs CLI is free and open-source, with no usage caps and without needing an Aviator account. Set up the CLI locally.
- [Default Branch Update Master to Main](https://docs.aviator.co/aviator-cli/faqs-and-troubleshooting/updating-default-branch-from-master-to-main.md): Documentation on updating default branch from master to main when using StackedPRs CLI.
- [Manpages for Stacked PRs CLI](https://docs.aviator.co/aviator-cli/manpages.md): Access manual pages for Stacked PRs CLI. Find documentation files with detailed information on commands, system calls, functions, and other resources.
- [av(1)](https://docs.aviator.co/aviator-cli/manpages/av.1.md): Learn more about the av(1) command, which allows you to manage stacked pull requests with Aviator. View subcomands related to av(1) in manual pages.
- [av-adopt Command Guide](https://docs.aviator.co/aviator-cli/manpages/av-adopt-1.md): Learn how to use the av-adopt command in Aviator CLI for seamless repository adoption.
- [av-auth-status(1) in CLI](https://docs.aviator.co/aviator-cli/manpages/av-auth-1.md): Access key information about the av-auth-status(1) command in manual pages for Stacked PRs CLI. Name, synopsis, and description in Aviator Documentation.
- [av-stack-branch(1) in CLI](https://docs.aviator.co/aviator-cli/manpages/av-branch-1.md): View the av-stack-branch(1) command documentation in manual pages for Stacked PRs CLI. Use this command to create or rename a branch in the stack.
- [av-commit-create(1) in CL](https://docs.aviator.co/aviator-cli/manpages/av-commit-1.md): Find information about the av-commit-create(1) command in manual pages for Stacked PRs CLI. Synopsis, description, and options in Aviator Documentation.
- [av-stack-diff(1) in CLI](https://docs.aviator.co/aviator-cli/manpages/av-diff-1.md): View manual pages for the av-stack-diff(1)  command in Stacked PRs CLI. The command generates the diff between the working tree and the parent branch.
- [av-fetch(1) in CLI](https://docs.aviator.co/aviator-cli/manpages/av-fetch-1.md): Learn more about the av-fetch(1) command in manual pages for Stacked PRs CLI. Fetch the latest repository state from GitHub with the Aviator developer suite.
- [av-git-interaction Command Guide](https://docs.aviator.co/aviator-cli/manpages/av-git-interaction-7.md): Discover how the av-git-interaction command improves Git workflows in Aviator CLI.
- [av-init(1) in CLI](https://docs.aviator.co/aviator-cli/manpages/av-init-1.md): View manual pages for the av-init(1) command. Aviator CLI internally stores metadata in the repository. This command initializes the metadata storage.
- [av-stack-next(1) in CLI](https://docs.aviator.co/aviator-cli/manpages/av-next-1.md): Access manual pages for the av-stack-next(1) command in Stacked PRs CLI documentation. This command will default to checking out the next branch in the stack.
- [av-orphan Command Guide](https://docs.aviator.co/aviator-cli/manpages/av-orphan-1.md): Learn how to use the av-orphan command to manage orphan branches efficiently in Aviator CLI.
- [av-pr-status(1) in CLI](https://docs.aviator.co/aviator-cli/manpages/av-pr-status-1.md): Manual pages for the av-pr-status(1) command in Stacked PRs CLI. Gets the status of the current branch's associated pull request and required status checks.
- [av-pr-create(1) in CLI](https://docs.aviator.co/aviator-cli/manpages/av-pr-1.md): Manual pages for the av-pr-create(1) command in Stacked PRs CLI. Use it to create a pull request for the current branch. Description, options, and examples.
- [av-stack-prev(1) in CLI](https://docs.aviator.co/aviator-cli/manpages/av-prev-1.md): Learn more about the av-stack-prev(1) command in Stacked PRs CLI documentation. This command will default to checking out the previous branch in the stack.
- [av-stack-reorder(1) in CLI](https://docs.aviator.co/aviator-cli/manpages/av-reorder-1.md): View av-stack-reorder(1) command documentation for Stacked PRs CLI. Use the command to re-arrange branches within the stack and drop or move commits.
- [av-reparent Command Guide](https://docs.aviator.co/aviator-cli/manpages/av-reparent-1.md): Understand the av-reparent command for restructuring Git branches in Aviator CLI.
- [av-restack Command Guide](https://docs.aviator.co/aviator-cli/manpages/av-restack-1.md): Optimize stacked pull requests using the av-restack command in Aviator CLI.
- [av-commit-split(1) in CLI](https://docs.aviator.co/aviator-cli/manpages/av-split-commit-1.md): View key information about the av-commit-split(1) command in manual pages for Stacked PRs CLI. Split the currently checked out commit into multiple commits.
- [av-switch Command Guide](https://docs.aviator.co/aviator-cli/manpages/av-switch-1.md): Learn how to use the av-switch command for seamless branch switching in Aviator CLI.
- [av-stack-sync(1) in CLI](https://docs.aviator.co/aviator-cli/manpages/av-sync-1.md): Access manual pages for the av-stack-sync(1) command in Stacked PRs CLI. This command is used to fetch and push the changes to the remote GitHub repository.
- [av-stack-tidy(1) in CLI](https://docs.aviator.co/aviator-cli/manpages/av-tidy-1.md): Manual pages for the av-stack-tidy(1) command in Stacked PRs CLI. This command detects deleted or merged branches and re-parents children of merged branches.
- [av-stack-tree(1) in CLI](https://docs.aviator.co/aviator-cli/manpages/av-tree-1.md): Learn more about the av-stack-tree(1) command in manual pages for Stacked PRs CLI. You can apply this command to show the tree of stacked branches.
- [Aviator CLI Major Releases](https://docs.aviator.co/aviator-cli/major-releases.md): Stay updated on the latest major releases of Aviator CLI, including features and improvements.
- [Aviator CLI v0.1.0 Release Notes](https://docs.aviator.co/aviator-cli/major-releases/v0.1.0.md): Explore new features, bug fixes, and enhancements in Aviator CLI v0.1.0 release.
- [Aviator's Chrome Extension](https://docs.aviator.co/aviator-chrome-extension.md): Access Aviator's Chrome extension for MergeQueue and AttentionSet features. Find implementation and usecase instructions in our documentation.
- [Enterprise Configuration](https://docs.aviator.co/aviator-chrome-extension/chrome-extension-enterprise-configuration.md): Configure the Aviator Chrome Extension for enterprise deployments using managed storage policies.
- [Pilot Automated Actions](https://docs.aviator.co/pilot-automated-actions.md): Aviator offers automated actions you can configure to perform specific actions depending on an event or scenario. Learn how to write custom scenarios here.
- [Scheduled Events](https://docs.aviator.co/pilot-automated-actions/scheduled-events.md): With the Aviator Pilot framework, you can configure rules to trigger actions on a specific fixed schedule. Get instructions on configuring a schedule here.
- [JavaScript Execution](https://docs.aviator.co/pilot-automated-actions/js-execution.md): Aviator allows for executing custom JS code with Pilot automated actions or the MergeQueue ready hook. Learn more details about how it happens in our guide.
- [Pilot Automated Actions Reference](https://docs.aviator.co/pilot-automated-actions/reference.md): Find references for Pilot Automation Actions to complete configuration more easily. References for GitHub, MergeQueue, Slack configurations and other resources.
- [GitHub Reference](https://docs.aviator.co/pilot-automated-actions/reference/github.md): Access the Github integration reference for Pilot Automation Actions. Learn what actions you can perform on GitHub issues and get command samples in our guide.
- [MergeQueue Reference](https://docs.aviator.co/pilot-automated-actions/reference/mergequeue.md): View the reference to MergeQueue's actions for Pilot Automation Actions. Use these actions to manage and automate workflows and streamline other operations.
- [Slack Reference](https://docs.aviator.co/pilot-automated-actions/reference/slack.md): Visit this reference page to view Slack actions for Pilot Automation Actions. They allow you to configure sending messages to Slack channels and other setups.
- [API and Integrations](https://docs.aviator.co/api.md): Use JSON, GraphQL, or webhook APIs to mutate resources and access Aviator.
- [Slack Integration Guide](https://docs.aviator.co/api/personal-integrations.md): Use the Slack integration guide to learn how to set up and customize notifications to receive updates about various Aviator events directly in Slack.
- [GraphQL API Quickstart](https://docs.aviator.co/api/graphql-api-quickstart.md): Use Aviator's GraphQL API to access pull request data.
- [Prometheus Metrics Setup for GCP](https://docs.aviator.co/api/how-to-collect-monitoring-metrics-in-gcp-prometheus.md): Learn how to setup Prometheus Metrics collection for GCP, with Open Telemetry collector running on GKE, to scrape and feed the Aviator Prometheus metrics.
- [Reference](https://docs.aviator.co/api/reference.md): Visit the Reference page to get quick access to JSON API, GraphQL. Webhooks, and Monitoring Metrics documentation .
- [JSON API](https://docs.aviator.co/api/reference/json-api.md): Access Aviator's JSON API reference documentation.
- [GraphQL](https://docs.aviator.co/api/reference/graphql.md): Access GraphQL API Reference in the Aviator documentation.
- [Webhooks](https://docs.aviator.co/api/reference/webhooks.md): Get instructions on using webhooks with the Aviator developer collaboration suite. Your app can use webhooks to subscribe to events on your Aviator account.
- [Monitoring Metrics](https://docs.aviator.co/api/reference/monitoring-metrics.md): Aviator provides monitoring metrics for Prometheus. Monitor your queue length and GitHub API usage.
- [Access Management](https://docs.aviator.co/manage/access-management.md): Find details on access management in Aviator. Learn how to manage team access, available user roles, Google SSO login, and SAML-based authentication config.
- [GitHub App Permissions](https://docs.aviator.co/manage/github-app-permissions.md): View core permissions the Aviator app requests on your GitHub repositories that you choose to connect with Aviator.
- [Security](https://docs.aviator.co/manage/security.md): View our organizational security rules. Information Security Program, related roles and responsibilities, third-party audits we undergo, and other details.
- [Aviator Agents Data Usage & Retention Policy](https://docs.aviator.co/manage/security/aviator-agents-data-usage-and-retention-policy.md): Learn how Aviator agents handle data securely. Explore our policies on data usage, storage, retention, and privacy to keep your engineering workflows safe.
- [On-Premise Installation](https://docs.aviator.co/manage/on-premise-installation.md): Get help with installing Aviator on-premise. In addition to the hosted version, you have an option to run Aviator on-premise using Helm or Docker Compose.
- [GitHub App for On-Prem](https://docs.aviator.co/manage/on-premise-installation/github-app-for-on-prem.md): Find details on using a GitHub App for on-premise Aviator installation. This page describes how to create and authorize a GitHub App for your on-prem setup.
- [GitHub OAuth for On-Prem](https://docs.aviator.co/manage/on-premise-installation/github-oauth-for-on-prem.md): Learn about using GitHub OAuth connection in Aviator and its configuration. GitHub OAuth maps a GitHub username to an Aviator user within a single installation.
- [Use Helm Instructions](https://docs.aviator.co/manage/on-premise-installation/use-helm.md): Use Helm for on-premise Aviator installation. Please reach out to howto@aviator.co for instructions on how to set up Kubernetes-based installation.
- [Use Docker Compose Instructions](https://docs.aviator.co/manage/on-premise-installation/use-docker-compose.md): Learn how to use Docker Compose for on-premise Aviator installation. Minimum requirements for the Aviator server, variable definitions, and configuration steps.
- [Prometheus endpoint](https://docs.aviator.co/manage/on-premise-installation/prometheus-endpoint.md): The web app server and the background worker server can serve the Prometheus endpoint. Learn how to enable scraping the metrics from endpoints in our guide.
- [Slack Integration for On-Premise](https://docs.aviator.co/manage/on-premise-installation/slack-integration.md): Learn steps to set up Slack notifications for on-prem installations. To use Aviator's Slack notifications, you will need to set up and connect a Slack app.
- [Google SSO Login for On-Prem](https://docs.aviator.co/manage/on-premise-installation/google-sso-login.md): Learn how to set up Google SSO for on-premise installation. Find guidelines on creating OAuth authorization credentials in the Google developer console.
- [OnPrem Release Notes](https://docs.aviator.co/manage/on-premise-installation/release-notes.md): Changelog for Aviator on-premise releases. Subscribe via RSS to get notified of new releases.
- [FAQs](https://docs.aviator.co/manage/faqs.md): Find answers to the most frequent questions about Aviator. MergeQueue and billing FAQs. You can also contact our support team directly.
- [Troubleshooting GitHub app connection](https://docs.aviator.co/manage/faqs/troubleshooting-github-app-connection.md): Learn how to troubleshoot the GitHub app connection with step-by-step instructions. Configured when setting up Aviator FlexReview, MergeQueue, or Releases.
- [MergeQueue FAQs](https://docs.aviator.co/manage/faqs/mergequeue.md): Read answers to the common questions users may face when using Aviator MergeQueue.
- [Billing FAQs](https://docs.aviator.co/manage/faqs/billing.md): Find answers to common questions about Aviator billing and payments. Charges, differences between collaborators and users, and more.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.aviator.co/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.