document tabs widget

[arschmitz]

document the tabs widget not sure the best way to do this since its a ui widget @scottgonzalez any suggestions here?

[scottgonzalez]

This is tricky. We have a similar situation with the color plugin in UI, and we just have a page (not an entry) with some details then link off to the official docs for more info: https://github.com/jquery/api.jqueryui.com/blob/master/pages/color-animation.md

Whatever we do here will affect a large portion of the site in the future, so we need to think through this carefully. A few options that come to mind are 1) Create a page that briefly describes the widget and links off to the UI site for actual docs. 2) Create a task to copy the entries from UI. 3) Manually copy the files and make edits if necessary (seems hard to maintain).

I'm not really sure what the best experience is for users though. It seems like they'd want to see the docs in the same place, but duplicating docs might be confusing.

@dmethvin @ajpiano @kswedberg @tjvantoll

[tjvantoll]

This is indeed a hard but important problem. I would say for now mobile should probably just take the same approach we use for the color plugin and create a short page that links to the UI docs.

I don't think there's a quick or easy answer here, and the page would be easy to write and easy to rip out if we come up with something better.

[jaspermdegroot]

I agree with @tjvantoll that for now probably the best solution is to create a page with an intro and a link to UI's Tabs documentation.

Manually copy files is indeed very hard to maintain. That should be a one way thing to avoid trouble, which would also mean we have to close PR's in the Mobile API docs repo and ask to make a new one in the UI repo :-( So I am not in favor of this.

I think we should link to the UI API docs, because users should be aware of that they are using UI widgets in Mobile. Having all docs at the same place is user-friendly, but they might be looking at the wrong version;
We are planning on using one download builder, but will not always release at the same time. So when you create a custom build you might be using a newer version of a UI widget than when you use the one that is included (and documented) in the latest stable Mobile release.

We could create a separate overview page like this only for the UI widgets that are included in Mobile. In the intro text we can make people aware of versions. Brief description can go below the links so there is no need to open a page first, we can link directly to the applicable UI docs (open in new tab).