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

Rethink API v1/v2 content #62

Open
MikePulsiferDOL opened this issue Oct 6, 2015 · 6 comments
Open

Rethink API v1/v2 content #62

MikePulsiferDOL opened this issue Oct 6, 2015 · 6 comments

Comments

@MikePulsiferDOL
Copy link
Contributor

More than one developer has gotten confused by the tabbed interface separating the v1 and v2 usage instructions. We need to come up with a better way to present this information.

@neilneyman
Copy link
Contributor

Would it be clearer if we simply moved the tabs to the center like on the quarry site ? Maybe also change something about the way they're labeled

@spoonstein
Copy link

I'm voting for two separate pages with a clear indicator for V1 and V2. Can we filter the documentation on datasets to show what V1 offers versus V2? That would help a developer decide which approach was needed.

@MikePulsiferDOL
Copy link
Contributor Author

I think we need to do some A/B testing. When we get to that point, I will arrange for another outside UX review. I would like to see a few options first, though.

@jfc3-dol
Copy link

Quick thought off the top of my head is maybe to have both versions on the same page but have in-page anchors to the different versions. Not sure if you want V1 or V2 first since there are not many datasets so far converted to V2.

@MikePulsiferDOL
Copy link
Contributor Author

One of the issues is that the user apparently doesn't know to look for the other content and just goes with what's in front of them. I think we need to find a way to ensure they consciously choose V1 or V2.

@neilneyman
Copy link
Contributor

The mobile version seems to have that problem solved -- perhaps a solution for desktop would also hide both tabs content until one is selected?

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

No branches or pull requests

4 participants