Update user documentation

[xiaq]

http://ridiculousfish.com/shell/user_doc/html/ is badly outdated. The footer says: Generated on Fri May 25 02:21:14 2012 for fish by doxygen 1.5.9

@ridiculousfish Perhaps write a script to update the user doc automatically :)

[siteshwar]

Also I think whole documentation needs to be reviewed and updated before Fish 2.0 release as it may be lagging behind.

[ridiculousfish]

The ridiculousfish.com documentation is for the beta, and I will close that site down when we release.

When we release fish 2.0, the site will be fishshell.com, and the online documentation will live at http://fishshell.com/docs/2.0/index.html . In fact it's already there, and should be up to date.

[siteshwar]

I noticed a few issues in the documentation. Here are the improvements I would like to see :

1. Add description of how auto suggestions work.
2. Update how completions work : http://fishshell.com/docs/2.0/index.html#completion
3. Update the design philosophy page. We break design laws at some places. For e.g. We have implemented our own version of echo for performance reasons which breaks law of minimalism. - http://fishshell.com/docs/2.0/design.html
4. Add GitHub fish-shell issues link in "Missing features and bugs" section. - http://fishshell.com/docs/2.0/index.html#todo
5. Add address of our IRC channel and mailing list in FAQs http://fishshell.com/docs/2.0/faq.html
6. Remove obsolete FAQs like http://fishshell.com/docs/2.0/faq.html#faq-cd-implicit

[siteshwar]

Also we need to add docs for printf builtin in Fish. Since we have derived printf from GNU Coreutils, we can just refer to http://www.gnu.org/software/coreutils/manual/html_node/printf-invocation.html

[siteshwar]

Added docs for printf in 516be01

[zanchey]

Outstanding issues from this list:

• Add description of how auto suggestions work.
• Update how completions work : http://fishshell.com/docs/2.0/index.html#completion

[mrshu]

@zanchey what is the state of this? Can I be of any help?

I see that there is a section on auto suggestions in tutorial, is that what you had in mind with this?

[zanchey]

I've made a separate issue to remind me about autosuggestions (#937). Any updates to the documentation are always welcome; completions might be a good place to start.

[davidxia]

@zanchey @siteshwar Is there still work to be done? Can I help out?

[zanchey]

I actually had a grand plan to rewrite large swathes of the non-reference part of the documentation, but it hasn't really happened yet. Any work improving the accuracy, completeness or readability of the documentation would be greatly appreciated.

[davidxia]

Any parts in particular?

[faho]

The docs at http://fishshell.com/docs/current/index.html document the latest release, so there's nothing to do here ("improve documentation" is pretty much an ongoing task that can just stay implicit).