From 2e3be0722dc5a99493102e151bab002b4cbb1f97 Mon Sep 17 00:00:00 2001
From: Paul Aromolaran <timmypaul2006@gmail.com>
Date: Tue, 13 Feb 2024 12:45:22 +0100
Subject: [PATCH] Update system configuration documentation to include TypeInfo
 (#9019)

---
 docs/pages/docs/config/config.md | 37 ++++++++++++++++++++------------
 1 file changed, 23 insertions(+), 14 deletions(-)

diff --git a/docs/pages/docs/config/config.md b/docs/pages/docs/config/config.md
index 4f123ab1d73..35d3c8e1131 100644
--- a/docs/pages/docs/config/config.md
+++ b/docs/pages/docs/config/config.md
@@ -32,6 +32,14 @@ We will cover each of these options below.
 The configuration object has a TypeScript type of `KeystoneConfig`, which can be imported from `@keystone-6/core/types`.
 This type definition should be considered the source of truth for the available configuration options.
 
+Note: It is important to pass a `TypeInfo` type argument to the config function as it ensures proper typing for the [Keystone Context](../context/overview.md). This type is automatically created in `.keystone/types`. You can customize the output path of the generated type by specifying it in the config object.
+
+```typescript
+import { TypeInfo } from ".keystone/types";
+
+export default config<TypeInfo>({ /* ... */ });
+```
+
 ## lists
 
 The `lists` config option is where you define the data model, or schema, of the Keystone system.
@@ -42,8 +50,9 @@ See the [Lists API](./lists) docs for details on how to use this function.
 ```typescript
 import type { ListSchemaConfig } from '@keystone-6/core/types';
 import { config } from '@keystone-6/core';
+import { TypeInfo } from ".keystone/types";
 
-export default config({
+export default config<TypeInfo>({
   lists: { /* ... */ },
   /* ... */
 });
@@ -74,7 +83,7 @@ These database types are powered by their corresponding Prisma database provider
 ### postgresql
 
 ```typescript
-export default config({
+export default config<TypeInfo>({
   db: {
     provider: 'postgresql',
     url: 'postgres://dbuser:dbpass@localhost:5432/keystone',
@@ -91,7 +100,7 @@ export default config({
 ### mysql
 
 ```typescript
-export default config({
+export default config<TypeInfo>({
   db: {
     provider: 'mysql',
     url: 'mysql://dbuser:dbpass@localhost:3306/keystone',
@@ -107,7 +116,7 @@ export default config({
 ### sqlite
 
 ```typescript
-export default config({
+export default config<TypeInfo>({
   db: {
     provider: 'sqlite',
     url: 'file:./keystone.db',
@@ -160,7 +169,7 @@ Advanced configuration:
   See the [Custom Admin UI Pages](../guides/custom-admin-ui-pages) guide for details on simpler ways to customise your Admin UI.
 
 ```typescript
-export default config({
+export default config<TypeInfo>({
   ui: {
     isDisabled: false,
     isAccessAllowed: async (context) => context.session !== undefined,
@@ -212,7 +221,7 @@ Options:
 - `extendHttpServer` (default: `undefined`): Allows you to extend the node `http` server that runs Keystone.
 
 ```typescript
-export default config({
+export default config<TypeInfo>({
   server: {
     cors: { origin: ['http://localhost:7777'], credentials: true },
     port: 3000,
@@ -236,7 +245,7 @@ The function is passed two arguments:
 For example, you could add your own request logging middleware:
 
 ```ts
-export default config({
+export default config<TypeInfo>({
   server: {
     extendExpressApp: (app) => {
       app.use((req, res, next) => {
@@ -251,7 +260,7 @@ export default config({
 Or add a custom route handler:
 
 ```ts
-export default config({
+export default config<TypeInfo>({
   server: {
     extendExpressApp: (app) => {
       app.get('/_version', (req, res) => {
@@ -265,7 +274,7 @@ export default config({
 You could also use it to add custom REST endpoints to your server, by creating a context for the request and using the Query API Keystone provides:
 
 ```ts
-export default config({
+export default config<TypeInfo>({
   server: {
 extendExpressApp: (app, commonContext) => {
       app.get('/api/users', async (req, res) => {
@@ -298,7 +307,7 @@ For example, this function could be used to listen for `'upgrade'` requests for
 import { WebSocketServer } from 'ws';
 import { useServer as wsUseServer } from 'graphql-ws/lib/use/ws';
 
-export default config({
+export default config<TypeInfo>({
   server: {
     extendHttpServer: (httpServer, commonContext, graphqlSchema) => {
       const wss = new WebSocketServer({
@@ -329,7 +338,7 @@ In general you will use `SessionStrategy` objects from the `@keystone-6/core/ses
 ```typescript
 import { statelessSessions } from '@keystone-6/core/session';
 
-export default config({
+export default config<TypeInfo>({
   session: statelessSessions({ /* ... */ }),
   /* ... */
 });
@@ -359,7 +368,7 @@ Options:
 - `schemaPath` (default: `schema.graphql`): The path of the generated GraphQL API schema.
 
 ```typescript
-export default config({
+export default config<TypeInfo>({
   graphql: {
     debug: process.env.NODE_ENV !== 'production',
     path: '/api/graphql',
@@ -386,7 +395,7 @@ It has a TypeScript type of `ExtendGraphqlSchema`.
 ```typescript
 import { config, graphql } from '@keystone-6/core';
 
-export default config({
+export default config<TypeInfo>({
   extendGraphqlSchema: keystoneSchema => {
     /* ... */
     return newExtendedSchema
@@ -472,7 +481,7 @@ const {
   S3_SECRET_ACCESS_KEY: secretAccessKey = 'keystone',
 } = process.env;
 
-export default config({
+export default config<TypeInfo>({
    /* ... */
   storage: {
     my_S3_images: {