Skip to content

Commit 139e81f

Browse files
committed
docs: add diagrams
1 parent 5a22bfa commit 139e81f

File tree

3 files changed

+556
-0
lines changed

3 files changed

+556
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ You may find a simple GraphQL server example in the following folder: [examples/
1919

2020
When you are using code-first approach in GraphQL Schema construction you may meet with problem when you cannot understand what entrypoints has your schema. And where exactly placed the code which serves this or that entrypoint.
2121

22+
![overview](./docs/diagrams/overview.drawio.svg)
23+
2224
`graphql-compose-modules` uses a file-system based schema entrypoint definition (something like does NextJS with its pages concept for routing). You just create folder `schema/` and put inside it the following sub-folders (root directories): `query`, `mutation` and `subscription`. Inside these folders you may put `.js` or `.ts` files with FieldConfigs. Assume you create the following directory structure:
2325

2426
```bash
@@ -122,6 +124,8 @@ You may use sub-folders for `Query` & `Mutation` and all servers supports this f
122124

123125
## API
124126

127+
![overview](./docs/diagrams/ast-transformation.drawio.svg)
128+
125129
For now I provide basic overview of available API methods and I will describe them later.
126130

127131
### Main API method:

0 commit comments

Comments
 (0)