Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Graphql tool page steps are not clear #8643

Closed
anupama-pathirage opened this issue Feb 5, 2024 · 0 comments · Fixed by #8673
Closed

Graphql tool page steps are not clear #8643

anupama-pathirage opened this issue Feb 5, 2024 · 0 comments · Fixed by #8673
Assignees
Labels
Reason/Other None of the other reasons. Type/Bug Bugs that need to be fixed.

Comments

@anupama-pathirage
Copy link
Contributor

anupama-pathirage commented Feb 5, 2024

Description

$subject in https://ballerina.io/learn/graphql-tool/#generate-a-client-from-a-graphql-config

Observed multiple issues related to readablility.

1. All the following highlighted things are steps to follow. Why use sub heading instead of steps. The steps are much easier to follow. At least add the prefixes Step1 : , Step 2: etc for each sub heading.
image

2. Reader can get confused on where to find this file content. If it is an empty file that we expect in this step, mention it.

image

3. What is GraphQL Foundation VSCode plugin. Link it

image

4. Description says 4 files, while it lists four files in the list.

image
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Reason/Other None of the other reasons. Type/Bug Bugs that need to be fixed.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants