You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/content/rafiki.mdx
+29Lines changed: 29 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,6 +30,35 @@ pnpm start
30
30
```
31
31
</Card>
32
32
33
+
<Cardtitle="After a GraphQL schema change"icon="star">
34
+
35
+
GraphQL schema changes are rare, but when they happen, here's what to do:
36
+
37
+
**Generate the GraphQL docs**
38
+
39
+
Run these commands in the `packages/documentation` folder:
40
+
41
+
```
42
+
npx spectaql config-auth.yml // Auth Admin API
43
+
44
+
npx spectaql config-backend.yml // Backend Admin API
45
+
```
46
+
47
+
These commands generate the static HTML files for the GraphQL API docs.
48
+
49
+
**Add custom pages to search indexing**
50
+
51
+
Open the generated HTML files (`src/pages/apis/graphql/auth/index.html` and `src/pages/apis/graphql/backend/index.html`) and add the `data-pagefind-body` attribute to the `<div id="docs">` element:
52
+
53
+
```
54
+
<div id="docs" data-pagefind-body>
55
+
...
56
+
</div>
57
+
```
58
+
59
+
This ensures that the GraphQL API docs are included in the site search.
0 commit comments