dotansimha / dotansimha/graphql-code-generator

Guides should mention that installing the cli and graphql is a prerequisite

Open
#7,964 0 comments 1 reaction 0 assignees View on GitHub
core docs
Dominant language
TypeScript
Stars
11.3k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
23

Description

The following guides:
https://www.graphql-code-generator.com/docs/guides/react
https://www.graphql-code-generator.com/docs/guides/vue
https://www.graphql-code-generator.com/docs/guides/angular
https://www.graphql-code-generator.com/docs/guides/svelte
https://www.graphql-code-generator.com/docs/guides/front-end-typescript-only
https://www.graphql-code-generator.com/docs/guides/graphql-server-apollo-yoga
https://www.graphql-code-generator.com/docs/guides/graphql-modules

Should mention that you first have to follow the install instructions over here: https://www.graphql-code-generator.com/docs/getting-started/installation

_____

This feedback was delivered via Crisp: https://app.crisp.chat/website/af9adec5-ddfa-4db9-a4a3-25769daf2fc2/inbox/session_940a27fb-033f-48ca-8f8e-dd3d4553f55d/

> **SOMEONE:** Hi, I am thinking of merely setting up a TypeScript type generator to frontend. So according to the docs, it seems to imply that I would only required to yarn add @graphql-codegen/typescript-operations and @graphql-codegen/typescript. Am I right in here? Would I still need to add graphql and @graphql-codegen/cli?

> **ME:** Yes, those two are mandatory installs. Is there anything misleading on the documentation that makes you think otherwise? https://www.graphql-code-generator.com/docs/getting-started/installation

> **SOMEONE:** Probably a nitpick but it does hit me, as I was searching information through Google and landed on frontend-typescript-only page. The first step, which is installation seems to tell me yarn add those typescript-related dependencies and should just work.
> Of course I later discovered that I will still need to build the schema thus graphQL.js is still needed.
> I think a quick link to installation page might help better for people whom are a bit impatient, but yet again, is a nitpick.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.