Docs

[shakeelmohamed]

We basically have 0 docs right now, a wiki would be nice 😄
Maybe we even make a separate repo just for docs? Then we can have zen-audio-player.github.io/docs be a valid URL

[shakeelmohamed]

Created a wiki, and added a Use Cases page as a start - hopefully more research will lead to more insight!

[shakeelmohamed]

Some general topics that would be helpful:

• How to get started quickly as a newbie
• How to test things locally (WAMP, MAMP, XAMPP) vs. opening the index.html file in a browser
• How to write tests
• What are our code conventions/style? (a .jshintrc would help a bunch here)
• How to install dependencies (frontend & test)
• How to run tests
• What to look for in a success/errored work session
• What is the contributing process like? (@shakeelmohamed's code review on the PR, contributor updates PR, repeat until everyone is satisfied)
• Branching model (basically master is locked down, and can only be pushed to via a PR that passes code review)
• Tools (why did we pick certain things? bower/node.js/specific dependencies/gitter/travis CI)

[BeigeBadger]

I'm happy to write the part on testing things locally. I may get some time this weekend - I'm pushing a site live tomorrow for a client (outside of my day job) so I've been out of action all this week. =\

[shakeelmohamed]

Rock on @BeigeBadger!

[ghost]

What's the progress on this so far? Ironically, I'm a newbie (at Zen Audio Player) and I'm looking for an approachable issue to tackle. I was wondering if docs would be a good place to start. :)

[shakeelmohamed]

Welcome @josectello! Beyond README.md and CONTRIBUTING.md, there's a few loose ends on the wiki. See if you can add a new page there just to test it, I may need to give you permissions

[ghost]

Thanks @shakeelmohamed. I went ahead and made a minor change to the front page of the wiki (mainly formatting), let me know if that looks alright!

As for CONTRIBUTING.md, is that something you guys would want to have in the repo? If so, I can fork and begin drafting something that expands more on contributions than the Contributions page of the wiki.

[shakeelmohamed]

Thanks @josectello, glad you have permissions - I've added you to the org!

We actually need the CONTRIBUTING.md file to show the banner you see when creating a new issue or pull request. We might want to reduce the contents of the file and move some content to the wiki, I think the length of the file may be intimidating to new users. What do you think about that?

[ghost]

I think I got it. So we want a quick start guide with maybe some screenshots of submitting a PR/issue for clarity to new users. Yeah I think that's a great idea.

Just making sure, there isn't currently a CONTRIBUTING.md, right? I looked through and didn't appear to find one.

[shakeelmohamed]

@josectello it's actually in the .github directory, I forgot we moved it

[ghost]

@shakeelmohamed Thanks, I'll get started on that this Monday.

[ghost]

Work has been keeping me very busy for the past few days. Hopefully I will begin to work on this tomorrow.

[shakeelmohamed]

No worries @josectello

[shakeelmohamed]

@josectello Do you want to triage the the comments/description in this issue? I'd like to see 2 lists, todo & done.

[ghost]

@shakeelmohamed I was just thinking the other day a list would be great. I'm away this weekend, but I'll hop on that Monday evening!

[shakeelmohamed]

@josectello perfect, thanks a ton!

[ghost]

@shakeelmohamed Would it be easier to open up a new issue with a list of tasks that can be ticked off in markdown? I don't think I can edit any comments/descriptions on here except my own.

[shakeelmohamed]

@josectello yep that would be perfect

[shakeelmohamed]

Closing in favor of #201, which is more organized thanks to @josectello