BioDrop icon indicating copy to clipboard operation
BioDrop copied to clipboard

[DOCS] Quckstart improvement - explain json structure

Open amandamartin-dev opened this issue 3 years ago • 9 comments

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

amandamartin-dev avatar Dec 29 '22 21:12 amandamartin-dev

It's great having you contribute to this project

Welcome to the community :nerd_face:

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.

github-actions[bot] avatar Dec 29 '22 21:12 github-actions[bot]

I would like to change that text, assign me this task

mohit1607 avatar Dec 30 '22 06:12 mohit1607

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.

mohit1607 avatar Dec 30 '22 06:12 mohit1607

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!

amandamartin-dev avatar Dec 30 '22 13:12 amandamartin-dev

Ok @amandamartin-dev thanks for reply I will try to do it.

mohit1607 avatar Dec 30 '22 16:12 mohit1607

Great collab everyone! I have assigned it to you @mohit1607

eddiejaoude avatar Dec 30 '22 16:12 eddiejaoude

Thanks eddie I will do it

mohit1607 avatar Jan 01 '23 09:01 mohit1607

Screenshot (5732) It should look like this.

mohit1607 avatar Jan 01 '23 09:01 mohit1607

Do I commit it ?

mohit1607 avatar Jan 01 '23 09:01 mohit1607

PR merged - please use closes #2538 in the PR so that it automatically closes the issue when PR is merged

eddiejaoude avatar Jan 11 '23 20:01 eddiejaoude