Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Improve Lackluster Documentation

See original GitHub issue

Documentation

i’ve so far seen quite a lot of questions revolving around documentation, specific to the graphql-js implementation and how to translate graphql schemas to the graphql-types.

the onepager on https://graphql.org/graphql-js/ does not even use GraphQLObjectType, or GraphQLSchema to define schemas but uses a template string instead.
the class GraphQLDirective is not even mentioned in the API Reference, which is extremely confusing when trying to wrap your head around how to use graphql properly with graphql-js.

i’m not experienced enought to create a pull request for this, but I think the javascript community would greatly benefit from better documentation on how the javascript specific implementation works with graphql.

and since the graphql-js package already exists, it makes no sense to just omit the documentation

#446 #811 #799

Issue Analytics

State:
Created 5 years ago
Reactions:22
Comments:8 (3 by maintainers)

Top GitHub Comments

1reaction

bombillazocommented, Sep 20, 2021

Updates on this? Recently started using GraphQL and the struggle has been real.

1reaction

IvanGoncharovcommented, Mar 30, 2019

@AdamT213 Thank you for volunteering 👍 ATM graphql.org is in a process of migrating from FB to Linux Foundation so it’s better to postpone this task until this process is finished.

Top Results From Across the Web

Poor Documentation: Why It Happens and How to Fix It

When documentation is accurate and complete, it works wonders at telling a patient's story and can even improve patient care. "That story is...

Best Practices that Improve the Quality of Documentation

Poor documentation can ruin a good product because users cannot get the right information, in the right way to understand the product.

Strategies for Improving Documentation

This guide has been written from the risk management perspective with the aim of enhancing team communication and continuity of care through improved...

Strategies for improving physician documentation in ... - NCBI

Conversely, poor documentation can affect continuity of patient care, particularly during care transitions, and may cause delays or errors in patient treatment ...

Key Strategies for Improving Clinical Documentation in 2020

Think twice before using the EHR copy-paste function: The ECRI Institute warns that poor use of copy-paste can affect clinical documentation ...