On Fri, Dec 3, 2010 at 1:15 PM, James Bowlin <bow...@mindspring.com> wrote:
>
> IMO, when a beginning user types "help<return>", giving them a
> short list of choices that fits on one page is much more friendly
> then taking them to the TOC of the current index.html which IMO
> is way too much information. Giving users access to a short list
> of about 20 help topics (via "help topics") would go a long way
> to making the entire fish system follow the law of discovery.
>
I think the fish user documentation could be improved, but it certainly
follows the law of discovery. You can find all the help topics but just
typing "help".
The main reason why the table of contents is so long is that it includes a
table of contents for the commands page. I believe this should be moved to
the commands page, so that they can click on the commands link at the top of
the page to get to it. Thus each page should have it's own table of
contents.
The links at the top could be shortened by changing:
"Main documentation page" -> "User Documentation"
"Design Documentation" -> "Design"
then we could add in a "Tutorial" link
The introduction should target a beginner, so if you think it should be
improved to be a better quick start to learning about the shell.
However, I think you are trying to do too much in one patch. Make small
changes so we can get something committed rather than trying to rewrite
everything in one patch and risk having everything get rejected.
------------------------------------------------------------------------------
Increase Visibility of Your 3D Game App & Earn a Chance To Win $500!
Tap into the largest installed PC base & get more eyes on your game by
optimizing for Intel(R) Graphics Technology. Get started today with the
Intel(R) Software Partner Program. Five $500 cash prizes are up for grabs.
http://p.sf.net/sfu/intelisp-dev2dev
_______________________________________________
Fish-users mailing list
Fish-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/fish-users
