-
-
Notifications
You must be signed in to change notification settings - Fork 3.9k
[DOCS] Quckstart improvement - explain json structure #2538
Comments
It's great having you contribute to this projectWelcome to the community 🤓If you would like to continue contributing to open source and would like to do it with an awesome inclusive community, you should join our Discord chat and our GitHub Organisation - we help and encourage each other to contribute to open source little and often 🤓 . Any questions let us know. |
I would like to change that text, assign me this task |
By observing I came to conclusion that we can edit the bolck of code in 9th step to include the whole json structure with links array. Is it good ? It will give a good understanding. |
hey @mohit1607 thanks for looking into this! I cannot assign you as I'm not a maintainer on this repo, but you are welcome to work on it as no one else is yet. When you make the adjustment you are suggesting, can you put some screenshots of the new directions/code so that it can be reviewed for clarity with your PR? It will be hard to know until anyone can see it, but it sounds good to try! |
Ok @amandamartin-dev thanks for reply I will try to do it. |
Great collab everyone! I have assigned it to you @mohit1607 |
Thanks eddie I will do it |
Do I commit it ? |
PR merged - please use |
Description
In step 8 where the first bit of JSON is presented, it is not explicitly stated that the next chunk of JSON should live inside the curly braces and not be copy/pasted below.
If a new user is not familiar with JSON they may not realize this and have confusing JSON errors when they try to merge at the end.
Recommend explaining briefly the json structure in step 8 or 9 to prevent this
Screenshots
No response
Additional information
No response
The text was updated successfully, but these errors were encountered: