mozilla / MozStumbler

Android Stumbler for Mozilla
http://location.services.mozilla.com
Mozilla Public License 2.0
621 stars 214 forks source link

Make map legend clearer #1699

Open pizzamaker opened 8 years ago

pizzamaker commented 8 years ago

What do the satellite and the binoculars mean?

Also, it says that blue squares are cell only reports, but I commonly get blue circles (and I suspect they're the same).

When the satellite says 4/6, what is that supposed to mean?

These things should be explained in the app or at least in the accompanying documentation.

crankycoder commented 8 years ago

Blue circles are wifi only reports. This should be in the Map Legend on the bottom left of the slide out panel.

Can you get a screen cap of the problem? I'm currently

The satellites indicate how many GPS satellites are in view.

Do you have time to help with the documentation effort? We've been falling behind on this for a long time now.

pizzamaker commented 8 years ago

Wi-Fi only reports show up as a purple circle here (note: I'm not colorblind :P).

The satellite thing should probably be in the map legend as well. Also, still not sure what the binoculars mean.

Where can I find the doc? I'd love to help.

crankycoder commented 8 years ago

tumblr_md3nrgoetf1rzqj3uo1_1280

There's no user facing documentation available yet. I can bootstrap in something that will emit to mozstumbler.readthedocs.org though.

I'll get it setup tomorrow with reStructuredText. You can see an example of how documentation text can be formatted by looking at the existing Ichnaea documentation over at: https://github.com/mozilla/ichnaea/tree/master/docs

crankycoder commented 8 years ago

@pizzamaker I've got a branch over at https://github.com/mozilla/MozStumbler/tree/gh-pages

I tried creating a branch using Python's Sphinx but decided - "Lets just use github and jekyll" to minimize the number of things we need to get people to write documentation.

I would just start writing documentation - good or bad - and we can iterate and improve it over time.

crankycoder commented 8 years ago

FYI - the final output gets published in the usual place for github pages - https://mozilla.github.io/MozStumbler/