leksah / leksah

Haskell IDE
leksah.org
Other
977 stars 109 forks source link

Improve user documentation #309

Open jaccokrijnen opened 8 years ago

jaccokrijnen commented 8 years ago

As @andrewufrank mentioned, the current user documentation at http://leksah.org/leksah_manual.pdf is from 2010. Since then quite some new features were added/changed. Maybe we can move the documentation to something like readthedocs. It makes maintaining the documentation a bit easier and it looks quite neat.

What is new/different since 2010 ( @hamishmack )? Some things I can think of

hamishmack commented 8 years ago

Maybe we can move the documentation to something like readthedocs.

Looks nice.

What is new/different since 2010 ( @hamishmack )?

There will be a lot of differences. We should probably treat the existing docs as a rough since some of the changes might be subtle.

Some of the new things are:

jaccokrijnen commented 7 years ago

I've converted the lyx documentation to reStructuredText, it's roughly working now at http://leksah.readthedocs.io/en/latest/index.html . @hamishmack can you set up a webhook for readthedocs? I can't edit those settings.

hamishmack commented 7 years ago

@jaccokrijnen done.

andrewufrank commented 7 years ago

the layout and usability looks nice, but content is way outdated - please mark this clearly on top and everypage which is not updated. it is misleading. can somebody in the know go through it - i may ask somebody to do the copy edit afterwards?

jaccokrijnen commented 7 years ago

Thanks @andrewufrank , I've added a warning message on all the doc pages. By the way, editing is really easy, you can do this through github as well (in the docs folder).

Next step is to get the content up-to-date, we should do this before the next release when the feature set is supposed to be at a more stable situation.