Skip to content
This repository was archived by the owner on May 29, 2019. It is now read-only.

documentation versioning - hard to tell what version features apply to #3670

Closed
ktiedt opened this issue May 14, 2015 · 5 comments
Closed

documentation versioning - hard to tell what version features apply to #3670

ktiedt opened this issue May 14, 2015 · 5 comments

Comments

@ktiedt
Copy link

ktiedt commented May 14, 2015

Just spent way more time than was necessary trying to resolve why tooltip-class did not work in our application only to find out (via commit history here) that it was a brand new feature only in the latest release...

After going back to the documentation I looked for indications of what version I might have been looking at and the only reference to the actual project version # was in the Download button at the top of the page. I know other projects have done it in the past and it may not be the simplest thing, but being able to specify what version of documentation you are looking at would have been a huge boon to solving this in a more timely fashion.

As per @Foxandxss here is a ticket to help track this issue

@rvanbaalen
Copy link
Contributor

I feel your pain and understand the issue. However, a huge refactor session is required to do this the right way if I'm right.

@ktiedt
Copy link
Author

ktiedt commented May 18, 2015

It could be as simple as when publishing the docs, moving the existing to /docs/vXXX and letting the latest publication take /docs (granted I have not looked how how the docs generation currently works)

I am aware that projects that do this, typically start with that goal in mind.

A simple solution would just to tag features with their "added in" version number so no changes are really necessary code wise, just an extra property in comments

@piotrd
Copy link

piotrd commented Jun 12, 2015

Yesterday I had exactly the same problem (with tooltip-class not working in version older than 0.13.0 and not being able to quickly tell that by looking at the docs).

👍 for creating "added in v. ..." badges. (I can help with that if anyone tells me how ;) )

Also, docs for Tooltips need updating: tooltip-html-unsafe is now deprecated and tooltip-html is a new, but undocumented option!

@Pickra
Copy link

Pickra commented Jul 30, 2015

Just had the same problem. Bootstrap has versioned docs, it would be great if they were supported here.

@wesleycho
Copy link
Contributor

I think we are going to want to revamp our homepage - the UX could use some work to make it easier to get to the component of interest.

This would be a large amount of work though, so I cannot give an estimate when this can be done, especially with the large amount of issues/PRs being tackled with - more maintainers is a necessity for some of this work, as requested in #3997.

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

5 participants