senchalabs / jsduck

Simple JavaScript Duckumentation generator.
http://docs.sencha.com/
GNU General Public License v3.0
1.5k stars 238 forks source link

Hiding a guide yet allowing it be accessed #557

Open ryan-nauman opened 10 years ago

ryan-nauman commented 10 years ago

We've restructured our guides some and would like to hide a guide from the nav/guides list but still allow people to access it (keeping old links from emails alive).

I've already got a few hacks relying on Docs.initEventTracking with listeners on the controllers. However, I don't see any controller events for when a particular tab is accessed. When someone is viewing the main guides list I want to hide the particular item from the nav and list of guides.

This also sort of leads to a second problem which is the lack of any kind of concrete classes for me to apply my selector. I have to rely on a selector using position or attributes like ext:url or textcontent.

Suggestions appreciated!

nene commented 10 years ago

This problem is not specific do guides. You can also move around classes, and the old links won't work any more.

I would suggest you version your docs instead. Place the version with new structure on a new URL. When generating the old version, you can use the --message option to provide a message about the old docs being outdated (the way --message works should be improved though, as it currently only places the warning message to the API docs index page).