Skip to content

Commit 6e59549

Browse files
authored
adding spectaql manual steps (#94)
1 parent 474aed3 commit 6e59549

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

src/content/docs/content/rafiki.mdx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,35 @@ pnpm start
3030
```
3131
</Card>
3232

33+
<Card title="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.
60+
</Card>
61+
3362
## Nouns
3463

3564
### Common nouns

0 commit comments

Comments
 (0)