Skip to content

Improve Documentation #212

Open
Open
@odalysadam

Description

@odalysadam

So just a friendly hint and maybe I'm not having the brightest day, but without much prior knowledge to the topic of json:apis I found your documention rather hard.
You get very much into the Initializer and the advanced features, but skip the basic parts like the Model defining process and how the attributes get mapped. (Having a "post" as a type here is just a tad misleading btw.)
If you could answer simple questions in your documentation like - "What are the parameters for those functions define, create etc.?", "Is it possible to define multiple models?", "Does update use PUT or PATCH?", "Can you define a Model as Read Only?" and I'm sure there's more - out of the box, you would give people a much easier start into using your project instead of looking elsewhere. Convenience is key. Make your project great again.

Much love

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