commons-app-documentation

📗 Android Documentation

This holds information on the Wikimedia Commons Android app.

👤 User Documentation

• How to install and use the app
• Getting app logs from Android Studio

❤️ Contributor Documentation

• Volunteers welcome!
• Translating the app

📱 App Information

Documentation about the App itself, not the implementation:

• Screen Structure
  • Tutorial for new users
  • Tutorial for reviewing content
• App Functionality
• Frequently Asked Questions

👩‍💻 Developer Documentation

• Contributing Guidelines
• Quick start guide for developers
• Developer workflow
• Code Style
• Libraries used
• Software design document
• Build variants types
• Changing build variants

🔧 Implementation

• Technical Overview
• Code walkthrough for new devs (draft)
• Category suggestions (readme)
• External APIs
• Tools Forge APIs
• DB Schema
• Code Structure
• On Device Storage

🧪 API testing:

• Fuzzy category search
• Location based category search

🚀 Maintainer documentation

• Project Maintenance
• Google Play store listing

🙌 Improving the docs

We appreciate any improvements you can make to the docs! Feel free to open pull requests with proposed changes and tag us for review.

If you’re a frequent contributor and have write access to one of the main projects do ask for write access here - pull requests are to prevent abuse and (for now at least) you can edit files directly.