search

nodejs / nodejs.org-archive

[DEPRECATED] Website repository for the Node.js project
105 stars 113 forks source link

Enhancement: Be able to select older node version when viewing API Reference Docs #145

Open charleswhchan opened 9 years ago

charleswhchan commented 9 years ago

node.js website currently displays the latest version of API Docs only (v0.12.5 at time or writing): https://nodejs.org/api

Older docs are available from https://nodejs.org/docs/, but is not obvious how to navigate to that page from the website. eg. v0.10.39 API is available from https://nodejs.org/docs/v0.10.39/api/

It would be extremely convenient if there was a way to select an alternative (non-latest) version of the API from the website, similar to Python documents: https://docs.python.org/2/library/

Don't need to show all the versions, maybe just the major ones? ie. v0.10.latest, v0.12.latest Perhaps with a link to all available versions for someone to view specific version.

Thoughts?

fhemberger commented 9 years ago

+1 on this. This is a good idea.

bnb commented 9 years ago

+1, but let's please not have it be an eyesore. Software Documentation is notoriously poorly designed, and this exact type of functionality usually adds bloat and ugliness if not done correctly.

mhdawson commented 9 years ago

+1 from me as well. I've had to look to find the older ones a few times. I think at least having easy navigation to find the docs for the major ones would be useful.

charleswhchan commented 9 years ago

Perhaps something really basic such as adding another link below 'API DOCS' called 'API DOCS (Previous Version)'?

See example in Docker's documentation: https://docs.docker.com/

bnb commented 9 years ago

@charleswhchan The dropdown they have there is nice. A simple link to another page with a <ul> and <li>s for each version would probably work as well.

charleswhchan commented 9 years ago

@bnb: I agree with your suggestion. That would work as well.