Bladeren bron

docs: Update docs for codegen script

Michael Bromley 7 jaren geleden
bovenliggende
commit
684297a8aa
2 gewijzigde bestanden met toevoegingen van 8 en 10 verwijderingen
  1. 8 0
      README.md
  2. 0 10
      admin-ui/README.md

+ 8 - 0
README.md

@@ -38,6 +38,14 @@ Vendure uses [TypeORM](http://typeorm.io), so it compatible will any database wh
 
 ## User Guide
 
+### Code Generation
+
+[apollo-cli](https://github.com/apollographql/apollo-cli) is used to automatically create TypeScript interfaces
+for all GraphQL queries used in the admin ui. These generated interfaces are used in both the admin ui and the server.
+
+Run `yarn generate-gql-types` to generate TypeScript interfaces based on these queries. The generated
+types are located at [`./shared/generated-types.ts`](./shared/generated-types.ts).
+
 ### Localization
 
 Vendure server will detect the most suitable locale based on the `Accept-Language` header of the client.

+ 0 - 10
admin-ui/README.md

@@ -6,16 +6,6 @@ It is an Angular application built with the Angular CLI.
 
 The UI is powered by the [Clarity Design System](https://vmware.github.io/clarity/).
 
-## GraphQL & Typings
-
-[apollo-codegen](https://github.com/apollographql/apollo-codegen) is used to automatically create TypeScript interfaces
-for all GraphQL queries used in the application.
-
-All queries should be located in the [`./src/app/data/queries`](src/app/data/queries) directory. 
-
-Run `yarn generate-gql-types` to generate TypeScript interfaces based on these queries. The generated
-types are located at [`./src/app/data/types/gql-generated-types.ts`](src/app/data/types/gql-generated-types.ts).
-
 ## Localization
 
 Localization of UI strings is handled by [ngx-translate](http://www.ngx-translate.com/). The translation strings should use the [ICU MessageFormat](http://userguide.icu-project.org/formatparse/messages).