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

Suggested change in documentation #99

Open
sashaboi opened this issue Mar 25, 2022 · 0 comments
Open

Suggested change in documentation #99

sashaboi opened this issue Mar 25, 2022 · 0 comments

Comments

@sashaboi
Copy link
Contributor

First of all great job with mockbee and mockman it is a true lifesaver and words fall short of how much time and effort is saved for all neogrammers in their journey learning frontend.

I have a doubt/ suggestion to make in the docs and please read this with the lens that this might be a very stupid/ obvious this which I ( onkar ) might have missed

The generic post private api calls in the e-com page are like so

{
action: {
type: "increment";
}
}
image

while in actuality when writing axios calls, we have to write

{
"action": {
"type": "increment | decrement";
}
}

this , for a beginner in js like me was not obvious , as i am used to just copypasting api calls from docs ( i have minor experience using razorpay api with python django)

So my question / suggestion is this : do the docs need to be of the first type or could they be modified a bit so as to make sure beginners like us who are the target audience users could have a smoother time with them?
thanks again for all the work Soham and Nada and team put in , great work !
Onkar Deshpande neog22

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

No branches or pull requests

1 participant