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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#7,964 0 comentarios 1 reacción 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
Medio día
Aptitud para principiantes
65/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
graphql, typescript
Área
documentation

Línea de trabajo

Abre las siete páginas de guía indicadas y compara sus pasos de instalación con la página getting-started/installation. Añade a cada guía un enlace o una nota clara sobre los requisitos previos que indique que CLI y graphql deben instalarse primero; después, verifica que las siete guías apunten de forma coherente a las instrucciones de instalación.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

core docs

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.

Lenguaje dominante
TypeScript
Estrellas
11.3k
Forks
1.4k
Merge medio
1 d 11 h
PR fusionados (30 d)
54

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de dotansimha/graphql-code-generator

Todos los issues de dotansimha/graphql-code-generator

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.