dzslides icon indicating copy to clipboard operation
dzslides copied to clipboard

Published 20 hours ago • verified publisher icon paulrouget

Need documentation

Open paulrouget opened this issue 13 years ago • 12 comments

paulrouget avatar Aug 06 '11 21:08 paulrouget

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

hsablonniere avatar Sep 12 '11 17:09 hsablonniere

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 avatar Sep 13 '11 18:09 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.

paulrouget avatar Sep 13 '11 22:09 paulrouget

+1

hsablonniere avatar Sep 14 '11 18:09 hsablonniere

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).

bdarcus avatar Oct 03 '11 13:10 bdarcus

See also pull #64.

paulrouget avatar Mar 08 '12 00:03 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

paulrouget avatar Mar 08 '12 02:03 paulrouget

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

hsablonniere avatar Mar 08 '12 03:03 hsablonniere

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

paulrouget avatar Mar 17 '12 14:03 paulrouget

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

hsablonniere avatar Mar 18 '12 11:03 hsablonniere

Issue #85 should be taken into account...

hsablonniere avatar May 10 '12 20:05 hsablonniere

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

hsablonniere avatar Jun 25 '12 19:06 hsablonniere