Improve docs - Githubissues

r0mflip commented 5 years ago

Checklist

[X] I have read the Contribution & Best practices Guide and my PR follows them.
[X] There is a corresponding issue for this pull request.
[X] My branch is up-to-date with the Upstream master branch.
[X] I have added necessary documentation (if appropriate)

Fixes #293

r0mflip commented 5 years ago

Still a WIP

r0mflip commented 5 years ago

I was also working on a simplified work flow diagram. WDYT?

meilix-gen

r0mflip commented 5 years ago

I would also like to suggest to use the same logo used on Meilix repo.

r0mflip commented 5 years ago

@tabesin: Please continue to include a reference to the gitter channel.

Please review the placement of the link.

@tabesin: This is a trivial web app that does not require much documentation other than the code or complex component descriptions.

I agree, but it took a group of(around 5 people, including me) more than an hour to understand and setup the whole thing with help from @meets2tarun and @xeon-zolt.

It was just quite complex to find where everything was and why it wasn't working. My main goal for this PR was to improve docs on Travis setup, which where other new people in the group struggled on(i've had previous Travis experiance).

fossasia / meilix-generator

Improve docs #347

Checklist