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

Create a new page "Getting started" to help beginners [website] #1618

Open
XenoBino opened this issue Mar 18, 2022 · 3 comments
Open

Create a new page "Getting started" to help beginners [website] #1618

XenoBino opened this issue Mar 18, 2022 · 3 comments
Labels

Comments

@XenoBino
Copy link

XenoBino commented Mar 18, 2022

A few weeks ago, I started learning json:api and , for a while, it was hard to tell what is going on. I had to read some examples two or three times and go back and forth from the specs to the example in order to have a full understanding of the fields and concepts.
That is the case for me, a person that has some experience reading specs. An unexperienced person would find it even harder to learn json:api.

I believe that a "Getting started" page would help more people understand (and use) json:api.
For the navigation bar, I suggest having "Examples", "Specifications" and the new "Getting started" in a dropdown that says "Learn".

@jelhan jelhan added the website label Mar 26, 2022
@MartenBE
Copy link

I can concur. I stumbled on JSON:API as a beginning backend dev and it is really overwhelming. I have experience in reading RFC's so I can lean on that experience, but the spec isn't really clear to read from top to bottom as it constantly refers to other chapters and semantics. It makes me consider using something like https://github.com/omniti-labs/jsend instead as every future contributor will have to debark on the same journey as me now to learn the daunting spec and will probably turn people away.
Lowering the initial "wall" with a tutorial or "getting started" would vastly help.

@dgeb
Copy link
Member

dgeb commented Jul 19, 2022

Thanks so much for this feedback @XenoBino and @MartenBE! It's important for those of us immersed in the spec to remember to try to see it with "beginners' eyes". We will prioritize a "getting started" section as we consider a revamp of the site.

@MartenBE
Copy link

Thank you very much. The project in itself is great by the way, really looking forward to using it!
I also found https://howtojsonapi.com/ , perhaps this could be included in the documentation for beginners?

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

No branches or pull requests

4 participants