From 3f74eff0fecbda6e7da8901db3b2f7d7c74cc581 Mon Sep 17 00:00:00 2001 From: James Date: Sun, 8 Nov 2020 10:31:59 -0500 Subject: [PATCH] adds additional docs --- docs/Components/overview.mdx | 7 +++++++ docs/Fields/overview.mdx | 7 +++++++ docs/Hooks/examples.mdx | 6 +++--- docs/Local-API/overview.mdx | 11 +++++++++++ docs/Production/security.mdx | 3 ++- docs/REST-API/config.mdx | 2 ++ 6 files changed, 32 insertions(+), 4 deletions(-) create mode 100644 docs/Components/overview.mdx create mode 100644 docs/Fields/overview.mdx create mode 100644 docs/Local-API/overview.mdx diff --git a/docs/Components/overview.mdx b/docs/Components/overview.mdx new file mode 100644 index 0000000000..d19f0a4723 --- /dev/null +++ b/docs/Components/overview.mdx @@ -0,0 +1,7 @@ +--- +title: Custom Components +label: Overview +order: 10 +--- + +Talk about how to build custom components. Show a list of all components that can be swapped out. diff --git a/docs/Fields/overview.mdx b/docs/Fields/overview.mdx new file mode 100644 index 0000000000..4ae7f8b0f2 --- /dev/null +++ b/docs/Fields/overview.mdx @@ -0,0 +1,7 @@ +--- +title: Fields Overview +label: Overview +order: 10 +--- + +List all field types here and link to each field type which should have its own documentation page. diff --git a/docs/Hooks/examples.mdx b/docs/Hooks/examples.mdx index a61c645791..e31b494f04 100644 --- a/docs/Hooks/examples.mdx +++ b/docs/Hooks/examples.mdx @@ -1,7 +1,7 @@ --- -title: Access Control Config -label: Config +title: Hooks Examples +label: Examples order: 20 --- -Show examples of how to write hook functions. +Show common examples of how to write hook functions. diff --git a/docs/Local-API/overview.mdx b/docs/Local-API/overview.mdx new file mode 100644 index 0000000000..4ac3bd0066 --- /dev/null +++ b/docs/Local-API/overview.mdx @@ -0,0 +1,11 @@ +--- +title: Server-Side Operations +label: Overview +order: 10 +--- + +Talk about how to run server-side operations. + +- Access control +- Providing a user + diff --git a/docs/Production/security.mdx b/docs/Production/security.mdx index 83b72fe927..b079395f01 100644 --- a/docs/Production/security.mdx +++ b/docs/Production/security.mdx @@ -1,9 +1,10 @@ --- title: Production Security Measures -label: Production +label: Security order: 20 --- - Rate limiting - GraphQL Complexity - Limits +- Max Depth diff --git a/docs/REST-API/config.mdx b/docs/REST-API/config.mdx index 0d8fa77f3f..dd534b29ab 100644 --- a/docs/REST-API/config.mdx +++ b/docs/REST-API/config.mdx @@ -8,3 +8,5 @@ Go over REST configuration options. - Middleware - Routes +- Depth +- Query parameters