Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/src/content/docs/setup/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,18 @@ In this guide you will add an existing, pre-baked workflow to an existing GitHub
thumbnail="/gh-aw/videos/install-and-add-workflow-in-cli.png"
/>

<details>
<summary>Prefer text? Read the Quick Start demo summary</summary>

<ol>
<li>Install the extension with <code>gh extension install github/gh-aw</code>.</li>
<li>From your repository root, run <code>gh aw add-wizard githubnext/agentics/daily-repo-status</code>.</li>
<li>Choose an AI engine and set the matching repository secret when prompted.</li>
<li>Let the wizard add <code>.github/workflows/daily-repo-status.md</code> and its compiled <code>.lock.yml</code>, then optionally trigger the first run.</li>
<li>Open the repository's <strong>Actions</strong> tab to watch the run, then check <strong>Issues</strong> for the generated daily report.</li>
</ol>
</details>

The aim here is to become familiar with **automated AI**: to install something that will run **automatically**, **recurringly**, in the context of your repository.

## Prerequisites
Expand Down
27 changes: 27 additions & 0 deletions docs/tests/quick-start-video-summary.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import { test, expect } from '@playwright/test';

test.describe('Quick Start video summary', () => {
test('should provide a text summary for the quick start demo video', async ({ page }) => {
await page.goto('/gh-aw/setup/quick-start/');

const quickStartSummary = page.locator('details').filter({
has: page.getByText('Prefer text? Read the Quick Start demo summary'),
});

await expect(quickStartSummary).toBeVisible();
await expect(quickStartSummary).not.toHaveJSProperty('open', true);
await expect(quickStartSummary).toContainText('gh extension install github/gh-aw');
await expect(quickStartSummary).toContainText(
'gh aw add-wizard githubnext/agentics/daily-repo-status'
);
await expect(quickStartSummary).toContainText(
'Choose an AI engine and set the matching repository secret when prompted.'
);
await expect(quickStartSummary).toContainText(
'Let the wizard add .github/workflows/daily-repo-status.md and its compiled .lock.yml'
);
await expect(quickStartSummary).toContainText(
'check Issues for the generated daily report'
);
});
});