diff --git a/src/content/docs/content/rafiki.mdx b/src/content/docs/content/rafiki.mdx index 4d54521..de4565a 100644 --- a/src/content/docs/content/rafiki.mdx +++ b/src/content/docs/content/rafiki.mdx @@ -30,6 +30,35 @@ pnpm start ``` + + +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 `
` element: + +``` +
+ ... +
+``` + +This ensures that the GraphQL API docs are included in the site search. + + ## Nouns ### Common nouns