droptheplot / apipony

Rails API documentation DSL
MIT License
11 stars 2 forks source link

Determine what we'd like to add before v1.0 #10

Open connorshea opened 8 years ago

connorshea commented 8 years ago

What would we like to have in order to release a 1.0.0 version? We should definitely follow semantic versioning, so once we get to that point we'll have to up the major version for any breaking changes.

cc: @AnthonySuper @droptheplot

droptheplot commented 8 years ago

I was thinking about adding body and attributes to single .panel with tabs to make page shorter. And, as someone asked on reddit, we could add description attributes for entire API, sections, requests and responses separately.

connorshea commented 8 years ago

Maybe take a look at some documentation provided by startups for their products and see how much of it we can reasonably do with the gem? If we find a common, useful feature in various API docs, we should try to generalize it.

connorshea commented 8 years ago

Also, would a Changelog be out-of-scope for this? e.g. GitHub and Stripe's respective changelogs.