Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add user documentation #14

Open
JayGray opened this issue Aug 29, 2013 · 9 comments
Open

Add user documentation #14

JayGray opened this issue Aug 29, 2013 · 9 comments
Assignees
Labels

Comments

@JayGray
Copy link
Member

JayGray commented Aug 29, 2013

No description provided.

@willbenica
Copy link
Contributor

@JayGray & @mschaaf,

We could start this. I would be happy to get this started. We'll just have to decide what kind of file format we'd like to have it in?

@JayGray
Copy link
Member Author

JayGray commented Aug 29, 2013

@willbenica
You can use the project wiki page. Should be easy to add, edit pages. I think a good starting point to how write wiki pages in github could be:
http://markdown.de/syntax/
Unfortunately in German. ;)

@mschaaf
Copy link
Member

mschaaf commented Aug 30, 2013

And this markdown can be used in the project readme.md and then github can generate from this file a nice and simple web site too.

@ghost ghost assigned willbenica Aug 30, 2013
@JayGray JayGray closed this as completed Sep 4, 2013
@willbenica
Copy link
Contributor

Added a few basic pages to the wiki.
Not much that I could do right now.

@mschaaf mschaaf reopened this Sep 4, 2013
@mschaaf
Copy link
Member

mschaaf commented Sep 4, 2013

We need a description of our application in the following places: README.md, package.json, wiki and dist specific files e.g. mac plist file.

@mschaaf
Copy link
Member

mschaaf commented Sep 4, 2013

We should have in our wiki descriptions about the features:

  • pressing return to send and also to use the send button for sending
  • drag and drop files in the message to send text box leads to sending the file
  • message list shows the last 10 messages
  • explain the client list

@mschaaf mschaaf closed this as completed Sep 4, 2013
@mschaaf mschaaf reopened this Sep 4, 2013
@mschaaf
Copy link
Member

mschaaf commented Sep 4, 2013

We should prepare description about using our dist packages.

@JayGray
Copy link
Member Author

JayGray commented Sep 4, 2013

We should also add our used node-modules like adm-zip and polo.

@mschaaf
Copy link
Member

mschaaf commented Oct 15, 2013

I added this wiki page https://github.com/Dica-Developer/quickQuestion/wiki/User-Documentation with lots of bullet point descriptions. What it now needs is some sentence made out of it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants