Need documentation

[paulrouget]

No description provided.

[hsablonniere]

Do you have ideas. I don't think we miss very much. The github page is quite fine.

[paulrouget]

I think we should write some solid doc in gh-pages (reflected here: http://paulrouget.com/dzslides/ )
I'll assign the bug to myself.

[paulrouget]

I see 4 places where we will find documentation:

1. Comments in template.html
   Must be very short and straight forward
2. github.com homepage (README)
   Explain the global concept, and how to run the slides.
3. wiki
   Should host internal doc (like the protocol), explain Shells.
4. dzslides homepage (paulrouget.com/dzslides)
   Here to promote dzslides, not technical documentation.

[hsablonniere]

+1

[bdarcus]

FWIW, I agree this is needed. I think the existing docs assume you already understand the system.

As a simple example, I have no clue, at all, what the "protocol" is about. And I guess related, I don't understand how to use the onscreen mode (e.g. what actually gets projected).

[paulrouget]

See also pull #64.

[paulrouget]

Comments in template.html
Must be very short and straight forward

I think we're good now.

github.com homepage (README)
Explain the global concept, and how to run the slides.

Still todo.

wiki
Should host internal doc (like the protocol), explain Shells.

The plan is to get rid of the Wiki (see pull #64).

dzslides homepage (paulrouget.com/dzslides)
Here to promote dzslides, not technical documentation.

Still todo.

Todo:

• more doc about the shells
• add keybindings

[hsablonniere]

I'll let you completely remove the wiki pages...

[paulrouget]

I am also working on a new home page: http://i.imgur.com/D7kp0.png WIP

[hsablonniere]

It looks nice. Prepare yourself for a lot of constructive remarks. We need a really awesome public page ;-)

[hsablonniere]

Issue #85 should be taken into account...

[hsablonniere]

We'll need the supported versions of different browsers...