Skip to content
This repository has been archived by the owner on Nov 20, 2017. It is now read-only.

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

Open
connorshea opened this issue Jan 3, 2016 · 3 comments
Open

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

connorshea opened this issue Jan 3, 2016 · 3 comments

Comments

@connorshea
Copy link
Collaborator

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
Copy link
Owner

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
Copy link
Collaborator Author

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
Copy link
Collaborator Author

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

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

No branches or pull requests

2 participants