Skip to content

Add deep links to upgrade guide for API changes #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jzaefferer opened this issue Mar 25, 2013 · 2 comments
Closed

Add deep links to upgrade guide for API changes #116

jzaefferer opened this issue Mar 25, 2013 · 2 comments

Comments

@jzaefferer
Copy link
Member

For example on the Accordion page, link to the 1.9 upgrade guide describing the changes from 1.8 to 1.9. Same for tabs. Or for dialog and progressbar in 1.10.

This would help anyone who's looking to upgrade his version of jQuery UI, when dealing with issues with a specific component.

Can be just a link and one sentence in the description.

@twhitmorenz
Copy link

Hey Jörn --

I raised an issues about the UI Docs myself, concerned with loss of depth (info like Tabs, preventing FOUC).

Scott says this detail should be on the "Learn jQuery" site, which I may or may not agree with, but in any case -- if it were -- it would need to be linked from the API site for anybody to actually find it.

#121

My preference is probably not for Usage Guide/ Usage Notes to be on a separate site, but be a closely-linked page on the same site.

I think "Upgrade Guides" should fall in the same situation; they are wanted closely-linked on the "API Docs" site, and need to be easily linked to so people can find them, not hidden in a distant galaxy far-far away.

What are your thoughts?

@jzaefferer
Copy link
Member Author

Hard to tell if this is still useful. We should do this for future releases though.

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

No branches or pull requests

2 participants