Skip to content

Suggested change in documentation  #99

@sashaboi

Description

@sashaboi

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions