Skip to content
This repository has been archived by the owner on Aug 7, 2024. It is now read-only.

[DOCS] Quckstart improvement - explain json structure #2538

Closed
amandamartin-dev opened this issue Dec 29, 2022 · 10 comments
Closed

[DOCS] Quckstart improvement - explain json structure #2538

amandamartin-dev opened this issue Dec 29, 2022 · 10 comments
Assignees
Labels

Comments

@amandamartin-dev
Copy link
Contributor

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

@github-actions
Copy link
Contributor

It's great having you contribute to this project

Welcome 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.

@mohit1607
Copy link
Contributor

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

@mohit1607
Copy link
Contributor

mohit1607 commented Dec 30, 2022

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.

@amandamartin-dev
Copy link
Contributor Author

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!

@mohit1607
Copy link
Contributor

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

@eddiejaoude
Copy link
Member

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

@mohit1607
Copy link
Contributor

mohit1607 commented Jan 1, 2023

Thanks eddie I will do it

@mohit1607
Copy link
Contributor

Screenshot (5732)
It should look like this.

@mohit1607
Copy link
Contributor

Do I commit it ?

@eddiejaoude
Copy link
Member

eddiejaoude commented Jan 11, 2023

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

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

No branches or pull requests

3 participants