apollo-client icon indicating copy to clipboard operation
apollo-client copied to clipboard

Can't find plain JS docs for browser or Node.

Open justinfagnani opened this issue 1 year ago • 5 comments

Intended outcome:

I want to use Apollo with vanilla JS (like web components) on the browser, and as a client in Node. I'd like to be able to find relevant docs from the site, presumably from links on https://www.apollographql.com/docs/

Actual outcome:

For client, I see only React, iOS, and Kotlin. I don't know where to look if I just want to see docs on Apollo in a browser. For Node, I guess there's mention in Apollo Server, but I need a client on Node.

How to reproduce the issue:

Naivgate to https://www.apollographql.com/docs/

See no mention of Apollo for JavaScript anywhere. Look in several places like the navigation popup:

Screen Shot 2022-07-20 at 1 51 35 PM

or the content outline:

Screen Shot 2022-07-20 at 1 51 50 PM

or the docs landing page:

Screen Shot 2022-07-20 at 1 51 58 PM

Versions

justinfagnani avatar Jul 20 '22 20:07 justinfagnani

While I wish they fix their docs page for sure, there was somewhere in there that you can use pretty much all of their examples outside of the ones specific to react if you import from @apollo/client/core and not from @apollo/client. Just recently started using their library for a Vue-Lit project, and that was so far the only annoyance 😉

adaliszk avatar Jul 21 '22 19:07 adaliszk

@justinfagnani thanks for reporting this. We are always interested in making our documentation better. I was curious if you had some thoughts on what you'd expect to see in a documentation section that was focused on using Apollo Client with Vanilla JS.

jpvajda avatar Jul 25 '22 20:07 jpvajda

@jpvajda I had a similar issue coming at this for the first time as the original poster.

If you're looking for js documentation to just get started and you see a lot of examples with 'react' it becomes unclear as to whether or not you're doing it wrong and there is a lot of unnecessary info to read through.

If you had a vanilla js section with the bare minimum to get started without the react bits, it would be more clear. I'm using graphql as a means of simply getting data into Alpine.js. Digging around a bit I'm trying to sort out if I should just fetch my requests or use Apollo. What things can/can't I do with either method etc. What will I gain/lose if anything...

Hope that helps a bit!

josh-tt avatar Sep 25 '22 05:09 josh-tt

@josh-tt Would you have any interest in submitting a PR to make this improvement to our documentation? We accept PRs for our Docs, we can definitely help you refine it, and organize it if you'd want to make this contribution. cc @StephenBarlow

jpvajda avatar Sep 28 '22 19:09 jpvajda

I am also trying to use Apollo client for an older project that uses StencilJS and would like to see this in plain javascript. The main site links to the React / JS page, but honestly, past the Get Started section it's all React.

Screenshot 2023-11-22 at 3 16 40 PM

orsi-meltwater avatar Nov 22 '23 20:11 orsi-meltwater