Skip to content

Commit

Permalink
add schema docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pettinarip committed Jun 7, 2022
1 parent cc3c753 commit 7458091
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/schema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Schema

Our schema, used in the Gatsby GraphQL layer, is defined under the `src/schema` folder. These files are then grabbed by the createSchemaCustomization`Gatsby hook in`gatsby-node.ts`.
There are two ways to define a schema in Gatsby:

- GraphQL SDL, the traditional way using [template literals](https://graphql.org/learn/schema/)
- And a more "programmatic" approach, which has more flexibility, [Gatsby Type Builders](https://www.gatsbyjs.com/docs/reference/graphql-data-layer/schema-customization/#gatsby-type-builders) with `schema.buildObjectType`

That is why you see two folders in /schema

- `src/schema/sdls` for GraphQL SDL
- `src/schema/builders` for Gatsby Type Builders

0 comments on commit 7458091

Please sign in to comment.