Code4HR / hrt-bus-finder

Web app for the HRT bus API, GitHub Pages, @bschoenfeld and @wbprice
hrtb.us
16 stars 33 forks source link

Swap Readme with Userguide for Mobile View #102

Open qwo opened 10 years ago

qwo commented 10 years ago

First image is link to the readme at
https://github.com/c4hrva/hrt-bus-finder/blob/gh-pages/README.md

Second is the Wiki page on the wiki section to the user guide https://github.com/c4hrva/hrt-bus-finder/wiki/User-Guide

I suggest swapping the contents because usability wise the github wikipages are not mobile optimized. I could not find a way to get it to display native.

The readme is automatically mobile and optimized making it more readable.

I think this will 1 make it more usable 2. encourage people to notice the source code is on github. .

--- Want to back this issue? **[Post a bounty on it!](https://www.bountysource.com/issues/26427436-swap-readme-with-userguide-for-mobile-view?utm_campaign=plugin&utm_content=tracker%2F161853&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://www.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F161853&utm_medium=issues&utm_source=github).
BretFisher commented 10 years ago

Maybe use Bootstrap Tour to show a step-through gui on first visit? http://bootstraptour.com/

qwo commented 10 years ago

adding bootstrap tour as the option when selecting userguide could be a good compromise.

Looks like a good fix for hacknight tonight

qwo commented 10 years ago

So yeah. I started adding bootstrap tour but when I tested it on my device and older devices.

its still running Javascript on phone devices.

The modal responses took over 5 seconds and were very clunky. It runs like a dream on desktop clients.

A better fix by @cosmicmeow was to make it another bootstrap page, not a github page and I'll add that