Skip to content

Commit 672b9ae

Browse files
authored
Fix a broken link (#25)
* Fix a broken link * Add check that docusaurus builds
1 parent 20d2bab commit 672b9ae

File tree

2 files changed

+49
-1
lines changed

2 files changed

+49
-1
lines changed
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Docusaurus Build Check
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
build:
11+
name: Build Docusaurus Site
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- uses: actions/checkout@v3
16+
17+
- name: Setup Node.js
18+
uses: actions/setup-node@v3
19+
with:
20+
node-version: '18'
21+
cache: 'npm'
22+
23+
- name: Install dependencies
24+
run: npm ci
25+
26+
- name: Build site
27+
run: npm run build
28+
29+
- name: Update PR Status
30+
if: github.event_name == 'pull_request'
31+
uses: actions/github-script@v6
32+
with:
33+
script: |
34+
const { owner, repo, number } = context.issue;
35+
const { sha } = context.payload.pull_request.head;
36+
37+
await github.rest.checks.create({
38+
owner,
39+
repo,
40+
name: 'Docusaurus Build',
41+
head_sha: sha,
42+
status: 'completed',
43+
conclusion: 'success',
44+
output: {
45+
title: 'Build Successful',
46+
summary: 'The Docusaurus site built successfully'
47+
}
48+
});

docs/advanced-usage/prompt-engineering.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Prompt engineering is the art of crafting effective instructions for AI models l
88
* **Bad:** "Fix the code."
99
* **Good:** "Fix the bug in the `calculateTotal` function that causes it to return incorrect results."
1010

11-
* **Provide Context:** Use [Context Mentions](./context-mentions) to refer to specific files, folders, or problems.
11+
* **Provide Context:** Use [Context Mentions](../basic-usage/context-mentions) to refer to specific files, folders, or problems.
1212
* **Good:** `@/src/utils.ts Refactor the \`calculateTotal\` function to use async/await.`
1313

1414
* **Break Down Tasks:** Divide complex tasks into smaller, well-defined steps.

0 commit comments

Comments
 (0)