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

docs: Update to GraphQL API Documentation #1203

Merged
merged 3 commits into from
Dec 20, 2021

Conversation

mrcleanandfresh
Copy link
Contributor

Within the last month I discovered this project and started implementing it in my own. I found the docs to be a little on the lean side, so I thought I would contribute to them.

I added an example of how to authenticate with a service using GraphQL. I used most of the information from this code. I was not sure of the "official" serviceName for each one of them though.

I would also like to add additional information for each of the services, but am not sure what content to write, or if it should be organized differently. So this is my first draft so to say. Please offer any feedback that would be helpful to fill out these docs a little more.

@changeset-bot
Copy link

changeset-bot bot commented Dec 12, 2021

🦋 Changeset detected

Latest commit: f1483c0

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@accounts/graphql-api Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@mrcleanandfresh mrcleanandfresh changed the title Update to GraphQL API Documentation feat: Update to GraphQL API Documentation Dec 12, 2021
@pradel
Copy link
Member

pradel commented Dec 14, 2021

Improving the documentation is definitely needed!
The update looks amazing, maybe you could add the same to the website documentation too what do you think?

@mrclean-oa
Copy link

maybe you could add the same to the website documentation too what do you think?

Absolutely! Can you point me in the right direction, so I can make that update? I didn't realize there were two places that needed updating. Anything I should know when updating the website docs?

@codecov
Copy link

codecov bot commented Dec 14, 2021

Codecov Report

Merging #1203 (f1483c0) into master (4f5b38e) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1203   +/-   ##
=======================================
  Coverage   95.28%   95.28%           
=======================================
  Files         106      106           
  Lines        2377     2377           
  Branches      473      473           
=======================================
  Hits         2265     2265           
  Misses        107      107           
  Partials        5        5           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4f5b38e...f1483c0. Read the comment docs.

@pradel
Copy link
Member

pradel commented Dec 14, 2021

All the website docs are located there https://github.com/accounts-js/accounts/tree/master/website/docs
Nothing in particular, we are using docusaurus and the website is there https://www.accountsjs.com/

@mrcleanandfresh
Copy link
Contributor Author

I've never used docusaurus so let me know if this is resolved in f1483c0. Didn't know how it determined when to start a new page, since I noticed the graphql.md file had both server and client in it.

@pradel
Copy link
Member

pradel commented Dec 20, 2021

Looks great like this!

@pradel pradel changed the title feat: Update to GraphQL API Documentation docs: Update to GraphQL API Documentation Dec 20, 2021
@pradel pradel merged commit 0a40221 into accounts-js:master Dec 20, 2021
@mrcleanandfresh mrcleanandfresh deleted the graphql-api-docs branch December 20, 2021 15:25
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

Successfully merging this pull request may close these issues.

3 participants