Skip to content

docs: adding spectaql manual steps #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 10, 2025
Merged

docs: adding spectaql manual steps #94

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 29 additions & 0 deletions src/content/docs/content/rafiki.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,35 @@ pnpm start
```
</Card>

<Card title="After a GraphQL schema change" icon="star">

GraphQL schema changes are rare, but when they happen, here's what to do:

**Generate the GraphQL docs**

Run these commands in the `packages/documentation` folder:

```
npx spectaql config-auth.yml // Auth Admin API

npx spectaql config-backend.yml // Backend Admin API
```

These commands generate the static HTML files for the GraphQL API docs.

**Add custom pages to search indexing**

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:

```
<div id="docs" data-pagefind-body>
...
</div>
```

This ensures that the GraphQL API docs are included in the site search.
</Card>

## Nouns

### Common nouns
Expand Down