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

[Documentation Request] Don't suggest class syntax first #930

Open
Hebilicious opened this issue Jun 2, 2023 · 1 comment
Open

[Documentation Request] Don't suggest class syntax first #930

Hebilicious opened this issue Jun 2, 2023 · 1 comment

Comments

@Hebilicious
Copy link

Hello @hayes, I can see Pothos has progressed a lot since the last time I checked it out.
Browsing the documentation, I have a gut feeling that potentials users are being turned off by the fact that the class syntax is documented first, and that the other 2 syntax are not well presented.

Have you thought of making the Typescript syntax (with objectRef and .implement) the "main" one ?
Or even the SimpleObject syntax the "main" one (I personally only use this style ...)
By main one I mean use it everywhere in the docs / readme example, and present the 2 other ones in an alternative syntax section.

It's nice to have options, but there's a large amount of JS developers who are allergic to classes (maybe react hooks transition PTSD 😄)

There's a new code first graphql library that is rising very quickly in popularity, and it might be because their docs are more "catchy" ? I think Pothos is great and well more fledge out, and this change will hopefully boost its popularity.

@hayes
Copy link
Owner

hayes commented Jun 3, 2023

Yes, this is definitely something I would like to do.at some point. Classes were never really meant to be prominent in the docs. PRe are more than welcome, but 100% agree that classes are over emphasized in a few places (especially in the relay docs)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants