Version selector for documentation and other improvements

[anilnatha]

Yesterday, I was reading the documentation for the Accordion component and when trying to implement it in my application, it didn't work. While investigating my issue, I found the 0.14.x migration guide, which while helpful, annoyed me a bit because had a link, or even just a mention of these changes been provided on the documentation page, it could have saved me some time since my app is currently running v0.13.4. While I have no reservations about upgrading to the latest version of Angular UI Bootstrap, others may. So providing documentation for older versions, in addition to new versions, would be most helpful, along with important details, like info about the migration guide.

So if I had to sum up what I would have liked to see on the documentation page:

1. A version selector so that developers could see documentation for older versions of Angular UI Bootstrap in addition to the latest version.
2. Improve the amount of detailed information included in the documentation that directly impact usage of the component(s) since this is typically the first place I feel many developers go for reference.

In some ways, this request may be related to Issue #4798

Thank you for your time.

[Foxandxss]

I am sorry but I am not following you at all.

What is the issue with the migration guide? Or perhaps you got confused because you were running 0.13.4?

Also, there is versioned docs, there is a dropdown in the docs page where you can change to other versions.

[wesleycho]

FWIW, the migration guide is linked in the README here.

[anilnatha]

Sorry for the confusion @Foxandxss. There is no issue with the migration guide. The issue I had is that no where on this documentation page was it stated that the prefixes were added. So a person running an older version that comes to the documentation page, isn't made aware that based on the documentation shown, you must be running version 0.14.x, but I can see now how I had confused you.

@wesleycho, thank for that bit of info, I suppose the part that is bothering me the most is that the documentation page made no mention of the migration guide, where it could have been most helpful. So my suggestion is to include details of that nature somewhere in the "Getting Started" portion of the documentation page. Especially for those that decide to upgrade, only to realize that you must change your tags for it to work, which again isn't mentioned on the documentation page.

As for the version selector, I apologize because I did miss the fact that at the very top of the page there is a 'previous docs' dropdown menu. Mea Culpa.

[Foxandxss]

we have a dropdown to select versions and you can see what is the actual version (in the download button).

what I agree on is having docs in the homepage + migration guide only in the wiki (wiki only have that interesting tbh).

So the point would be having something in the homepage that links to migration guide. The whole homepage needs a new face to be honest.

I hear your issues and I agree with them. Do you want to help fixing that? We all give our free time to this project so we could use more help on that.

[Foxandxss]

I created a PR to put the migration guide link on the homepage. About the version. I have mixed feelings, you can see it like:

That always worked for me. That doesn't mean that it should work for everyone else.

[anilnatha]

@Foxandxss Thank you for making the changes and creating the PR. I appreciate it.

I understand that many of the projects on GitHub are community driven and it takes a lot of effort to keep them going. I would be happy to help as best I can. I will read up on the contribution guidelines and read through some of the issues in hopes that I can find something that I can work on.

[wesleycho]

I think you meant @Foxandxss :P . The only thing left is for him to retrofit the existing docs so it has this improvement.

[Foxandxss]

Ah, I knew I had to do something. I will retrofit to add the migration guide to 0.14.0+ and about making visible the current version, I don't know, I like the button.

[anilnatha]

Whoops! Fixed mention. ;)

[Foxandxss]

I retrofitted the migration thing to all 0.14.x versions.

I am not going to make any change to put the doc version in another place. I don't find a good idea for that.