Home Download Buy Blog Forum Support

Request to take down ST1 Documentation

Request to take down ST1 Documentation

Postby skuroda on Tue Mar 12, 2013 5:52 am

Just a request to remove the ST1 documentation or add a clear message that those are outdated. Either that or, like http://sublimetext.info/docs/en/index.html, add a deprecated message. I haven't seen a way to navigate to it within the site, but it still comes up in web searches. Here is a link to some of that documentation that I would like to see removed or updated with a deprecation mehtod. http://www.sublimetext.com/docs/file-type-preferences

Thank you.
skuroda
 
Posts: 683
Joined: Fri Oct 05, 2012 8:11 am

Re: Request to take down ST1 Documentation

Postby robertcollier4 on Wed Mar 13, 2013 9:12 am

The documentation layout is extremely confusing. I usually search for something on Google and I get a result for a page. The doc pages show no context or tree around them to show how to navigate to other pages in the documentation. There are many times I have done a search - found a ST1 page (and not known it) - and then I assumed it was the current documentation so had to ask for help on this forum. I can vouch that if the documentation was better layed out these forums would be operating much more smoothly - since many new users here have to ask basic API usage questions since they are unable to find things properly in the docs.

Bad layout from official Docs - no context or tree to allow user to read the rest of the documentation:
http://www.sublimetext.com/docs/key-bindings

Good layout from unofficial Docs - has a left tree, if a user finds a page they can find other stuff and start learning plugin dev:
http://docs.sublimetext.info/en/latest/ ... s_osx.html

Another example of a good layout showing a left tree of the structure of the documentation:
http://www.stripesframework.org/display ... Extensions
robertcollier4
 
Posts: 154
Joined: Sun Feb 24, 2013 5:37 pm


Return to Technical Support

Who is online

Users browsing this forum: Yahoo [Bot] and 51 guests