Documentation of GraphQLScalarType is outdated #2567
Labels
Milestone
Comments
|
@Cito this seems pretty straightforward. Have you completed this yet? If not, I'll get it done if you'll assign me. |
|
@overhead525 no, haven't done anything about this yet. @IvanGoncharov can you assign it to him? |
This was referenced Apr 2, 2022
|
Changes in #3812 would also require documentation update |
JoviDeCroock
added a commit
that referenced
this issue
Nov 2, 2024
yaacovCR
pushed a commit
to yaacovCR/graphql-js
that referenced
this issue
Nov 26, 2024
Ultimately I was trying this out to see whether we can tweak the docs easily, it made me realize that our docs are tailored to general GraphQL rather than how do we use this library. It made me come up with a few suggestions - We should have a toggle on code examples to switch between `buildSchema` and programatically creating the schema with i.e. `GraphQLObjectType` - Our documentation starts with a tutorial, this ultimately feels like a mistake, we should lead with an explanation of what GraphQL.JS is and what it aims to do, clearly outlining the goals of this project - We should line out use-cases for building on this library and best practices of how to go to production Resolves graphql#2941 Resolves graphql#2567
yaacovCR
pushed a commit
to yaacovCR/graphql-js
that referenced
this issue
Dec 3, 2024
Ultimately I was trying this out to see whether we can tweak the docs easily, it made me realize that our docs are tailored to general GraphQL rather than how do we use this library. It made me come up with a few suggestions - We should have a toggle on code examples to switch between `buildSchema` and programatically creating the schema with i.e. `GraphQLObjectType` - Our documentation starts with a tutorial, this ultimately feels like a mistake, we should lead with an explanation of what GraphQL.JS is and what it aims to do, clearly outlining the goals of this project - We should line out use-cases for building on this library and best practices of how to go to production Resolves graphql#2941 Resolves graphql#2567
yaacovCR
pushed a commit
to yaacovCR/graphql-js
that referenced
this issue
Dec 3, 2024
Ultimately I was trying this out to see whether we can tweak the docs easily, it made me realize that our docs are tailored to general GraphQL rather than how do we use this library. It made me come up with a few suggestions - We should have a toggle on code examples to switch between `buildSchema` and programatically creating the schema with i.e. `GraphQLObjectType` - Our documentation starts with a tutorial, this ultimately feels like a mistake, we should lead with an explanation of what GraphQL.JS is and what it aims to do, clearly outlining the goals of this project - We should line out use-cases for building on this library and best practices of how to go to production Resolves graphql#2941 Resolves graphql#2567
yaacovCR
pushed a commit
to yaacovCR/graphql-js
that referenced
this issue
Dec 3, 2024
Ultimately I was trying this out to see whether we can tweak the docs easily, it made me realize that our docs are tailored to general GraphQL rather than how do we use this library. It made me come up with a few suggestions - We should have a toggle on code examples to switch between `buildSchema` and programatically creating the schema with i.e. `GraphQLObjectType` - Our documentation starts with a tutorial, this ultimately feels like a mistake, we should lead with an explanation of what GraphQL.JS is and what it aims to do, clearly outlining the goals of this project - We should line out use-cases for building on this library and best practices of how to go to production Resolves graphql#2941 Resolves graphql#2567
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The documentation for the GraphQLScalarType is outdated compared with the current code. For instance,
parseLitealtakes a valueNode and a variables parameter instead of just one valueAST parameter (I think that was changed in 0.12), and there are some more differences.The text was updated successfully, but these errors were encountered: