Here are some notes and suggestions regarding the setup instructions for the webmaker-android project, which I followed on June 29, 2015.
I can either file these suggestions as issues, or issue PRs for them directly.
-
The "Android" section of
README.md
says:If you make a change regarding activities within this native Android wrapper, you will need to update the
res/xml/app_tracker.xml
file to create a display name for that new activity, in Google Analytics.I'm not sure what "activities" means in this context. Also, this seems to be something that belongs in the "Adding New Pages or Components" or the "Google Analytics Event Firing" section, or in some other section entirely, rather than at the beginning of the Android setup instructions.
-
The instructions to run
npm start
should also be mentioned under the "Android" section, perhaps listed as an alternative tonpm run build
, since it's required to continuously build the Web assets. It should also be mentioned that devs need to rebuild the Android project after they've edited any Web assets. -
The file
_docs/get_started/README.md
seems to duplicate a lot of the information contained in the rootREADME.md
. I think we might want to simply get rid of it. -
The file
_docs/android.md
isn't linked-to from the rootREADME.md
. However, rather than linking to it, we might just want to get rid of the file, and mention Chrome Remote Debugging inREADME.md
--sinceREADME.md
already contains much of the information inandroid.md
in a more compact form (as it links out to more well-maintained external documentation). If we do this, we can get rid of the_docs
directory entirely.
These points were subsequently addressed in the following issues/PRs:
mozilla/webmaker-android#2363
mozilla/webmaker-android#2364