Starting Docs structure #994
Conversation
|
👍 |
| has_many :comments | ||
| has_one :author | ||
|
|
||
| url :post |
|
Looks great! I'd be okay with merging this |
|
I might also want to add a section (not necessariliy in this PR) differences from 0.8 and 0.9, performance, design, extending, etc. |
|
Awesome @bf4. |
| or | ||
|
|
||
| ```ruby | ||
| ActiveModel::Serializer.config.adapter = ActiveModel::Serializer::Adapter::Json |
There was a problem hiding this comment.
Above, you call it json_api but here it's json.
There was a problem hiding this comment.
Also, I think we should stick with one convention on how to define adapters. Either class or symbol.
Or maybe something like
ActiveModel::Serializer.config.adapter = :json_api
You can also specify a class as adapter, as long as it complies with the AMS adapters interface.
There was a problem hiding this comment.
Which makes me think that it'd make sense to create a doc on "How to create your own adapter".
|
Looks good. Minor comments. |
| @@ -0,0 +1,26 @@ | |||
| # Docs - ActiveModel::Serializer 0.10.x | |||
|
|
|||
| This is the documentation of AMS, it's focused on **0.10.x version.** | |||
|
Thank you all for reviewing it! I've updated it if all suggestions. |
We have being discussing about wiki and docs for a while.
It's time for us to help new and old AMS users to have a proper location to find general documentation and even 'how to' pages.
We decided to move forward with a
docs/*. This PR is the initial implementation of it.