You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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".
The text was updated successfully, but these errors were encountered:
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.
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.
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?
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".
The text was updated successfully, but these errors were encountered: