Skip to content

Commit 67acd37

Browse files
committed
Revert "docs: add automated PR review gate setup guide (#43)"
This reverts commit 4466a02.
1 parent 0565c1b commit 67acd37

6 files changed

Lines changed: 2 additions & 324 deletions

File tree

docs/astro.config.mjs

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/guides/REVIEW_GATE_SETUP_GUIDE.md

Lines changed: 0 additions & 155 deletions
This file was deleted.

docs/guides/USER_GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ There are six ways to interact with the platform. You can use them independently
88

99
1. **CLI** (recommended) - The `bgagent` CLI authenticates via Cognito and calls the Task API. Best for individual developers submitting tasks from the terminal. Handles login, token caching, and output formatting.
1010
2. **REST API** (direct) - Call the Task API endpoints directly with a JWT token. Best for building custom integrations, dashboards, or internal tools on top of the platform. Full validation, audit logging, and idempotency support.
11-
3. **Webhook** - External systems (CI pipelines, GitHub Actions) can create tasks via HMAC-authenticated HTTP requests. Best for automated workflows where tasks should be triggered by events (e.g., a new issue is labeled, a PR needs review). No Cognito credentials needed; uses a shared secret per integration. For the turnkey "auto-review every green PR" setup, see the [Automated PR review gate setup guide](./REVIEW_GATE_SETUP_GUIDE.md).
11+
3. **Webhook** - External systems (CI pipelines, GitHub Actions) can create tasks via HMAC-authenticated HTTP requests. Best for automated workflows where tasks should be triggered by events (e.g., a new issue is labeled, a PR needs review). No Cognito credentials needed; uses a shared secret per integration.
1212
4. **Slack** - Submit tasks by @mentioning the bot and receive threaded progress notifications with reaction-based status. See the [Slack setup guide](./SLACK_SETUP_GUIDE.md).
1313
5. **Linear** - Apply a label to a Linear issue to trigger a task; the agent posts progress comments back on the issue via Linear's MCP server. The label has variants — `bgagent` (do it), `bgagent:decompose` (plan a multi-part issue and wait for your approval), `bgagent:auto` (plan and start), and `bgagent:help` (explain the labels). See [Trigger labels](./LINEAR_SETUP_GUIDE.md#trigger-labels) in the Linear setup guide.
1414
6. **Jira** - Add a label to a Jira Cloud issue to trigger a task; the agent posts progress comments back on the issue via the Jira REST v3 API. See the [Jira setup guide](./JIRA_SETUP_GUIDE.md).

docs/scripts/sync-starlight.mjs

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ function rewriteDocsLinkTarget(target) {
4747
LINEAR_PAK_MIGRATION_RUNBOOK: '/using/linear-pak-migration-runbook',
4848
JIRA_SETUP_GUIDE: '/using/jira-setup-guide',
4949
DEPLOY_PREVIEW_SCREENSHOTS_GUIDE: '/using/deploy-preview-screenshots-guide',
50-
REVIEW_GATE_SETUP_GUIDE: '/using/review-gate-setup-guide',
5150
CEDAR_POLICY_GUIDE: '/customizing/cedar-policies',
5251
DEPLOYMENT_GUIDE: '/getting-started/deployment-guide',
5352
};
@@ -296,12 +295,6 @@ mirrorMarkdownFile(
296295
path.join('src', 'content', 'docs', 'using', 'Deploy-preview-screenshots-guide.md'),
297296
);
298297

299-
// --- Automated PR review gate setup guide: mirror to using/ ---
300-
mirrorMarkdownFile(
301-
path.join(docsRoot, 'guides', 'REVIEW_GATE_SETUP_GUIDE.md'),
302-
path.join('src', 'content', 'docs', 'using', 'Review-gate-setup-guide.md'),
303-
);
304-
305298
// --- Cedar Policy Guide: mirror to customizing/ (authoring reference for blueprint authors) ---
306299
mirrorMarkdownFile(
307300
path.join(docsRoot, 'guides', 'CEDAR_POLICY_GUIDE.md'),

docs/src/content/docs/using/Overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ There are six ways to interact with the platform. You can use them independently
88

99
1. **CLI** (recommended) - The `bgagent` CLI authenticates via Cognito and calls the Task API. Best for individual developers submitting tasks from the terminal. Handles login, token caching, and output formatting.
1010
2. **REST API** (direct) - Call the Task API endpoints directly with a JWT token. Best for building custom integrations, dashboards, or internal tools on top of the platform. Full validation, audit logging, and idempotency support.
11-
3. **Webhook** - External systems (CI pipelines, GitHub Actions) can create tasks via HMAC-authenticated HTTP requests. Best for automated workflows where tasks should be triggered by events (e.g., a new issue is labeled, a PR needs review). No Cognito credentials needed; uses a shared secret per integration. For the turnkey "auto-review every green PR" setup, see the [Automated PR review gate setup guide](/sample-autonomous-cloud-coding-agents/using/review-gate-setup-guide).
11+
3. **Webhook** - External systems (CI pipelines, GitHub Actions) can create tasks via HMAC-authenticated HTTP requests. Best for automated workflows where tasks should be triggered by events (e.g., a new issue is labeled, a PR needs review). No Cognito credentials needed; uses a shared secret per integration.
1212
4. **Slack** - Submit tasks by @mentioning the bot and receive threaded progress notifications with reaction-based status. See the [Slack setup guide](/sample-autonomous-cloud-coding-agents/using/slack-setup-guide).
1313
5. **Linear** - Apply a label to a Linear issue to trigger a task; the agent posts progress comments back on the issue via Linear's MCP server. The label has variants — `bgagent` (do it), `bgagent:decompose` (plan a multi-part issue and wait for your approval), `bgagent:auto` (plan and start), and `bgagent:help` (explain the labels). See [Trigger labels](/sample-autonomous-cloud-coding-agents/using/linear-setup-guide#trigger-labels) in the Linear setup guide.
1414
6. **Jira** - Add a label to a Jira Cloud issue to trigger a task; the agent posts progress comments back on the issue via the Jira REST v3 API. See the [Jira setup guide](/sample-autonomous-cloud-coding-agents/using/jira-setup-guide).

0 commit comments

Comments
 (0)