Skip to content

Commit 0481852

Browse files
committed
Move android docs into their own folder
1 parent f2a24ba commit 0481852

40 files changed

+73
-42
lines changed

README.md

+8-42
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,13 @@
1-
# User Documentation
1+
# 📝 Documentation
22

3-
- [How to install and use the app](How-to-install-and-use-the-app.md)
4-
- [Getting app logs from Android Studio](Getting-app-logs-from-Android-Studio.md)
3+
This repository acts as a wiki containing documentation for the Wikimedia Commons apps.
54

6-
# Contributor Documentation
5+
- [📗 Android](android/README.md)
6+
- [📓 iOS](ios/README.md)
77

8-
- [Volunteers welcome!](Volunteers-welcome!.md)
9-
- [Translating the app](Translating-the-app.md)
8+
<!-- This is copied across README.md, ios/README.md, android/README.md - please keep them in sync! -->
9+
## 🙌 Improving the docs
1010

11-
# Developer Documentation
11+
We appreciate any improvements you can make to the docs! Feel free to open pull requests with proposed changes and tag us for review.
1212

13-
- [Contributing Guidelines](Contributing-Guidelines.md)
14-
- [Quick start guide for developers](Quick-start-guide-for-Developers.md)
15-
- [Developer workflow](Developer-workflow.md)
16-
- [Code Style](Code-style.md)
17-
- [Libraries used](Libraries-used.md)
18-
- [Project Maintenance](Project-maintenance.md)
19-
- [Software design document](Software-design-document.md)
20-
21-
## Implementation
22-
23-
* [Technical Overview](Technical-Overview.md)
24-
* [Code walkthrough for new devs (draft)](Code-walkthrough-for-new-devs-(draft).md)
25-
* [Category suggestions (readme)](Category-suggestions-(readme).md)
26-
* [External APIs](External-APIs.md)
27-
* [Code Structure](Code-Structure.md)
28-
* [On Device Storage](On-Device-Storage.md)
29-
30-
## App Information
31-
32-
Documentation about the App itself, not the implementation:
33-
34-
* [Screen Structure](Screen-structure.md)
35-
* [Tutorial for new users](Tutorial-for-new-users.md)
36-
* [App Functionality](App-functionality.md)
37-
* [Frequently Asked Questions](Frequently-Asked-Questions.md)
38-
39-
40-
## API testing:
41-
42-
- [Fuzzy category search](Fuzzy-category-search.md)
43-
- [Location based category search](Location-based-category-search.md)
44-
45-
## Publish
46-
47-
- [Google Play store listing](Google-Play-store-listing.md)
13+
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.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

android/README.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# 📗 Android Documentation
2+
3+
## 👤 User Documentation
4+
5+
- [How to install and use the app](How-to-install-and-use-the-app.md)
6+
- [Getting app logs from Android Studio](Getting-app-logs-from-Android-Studio.md)
7+
8+
## ❤️ Contributor Documentation
9+
10+
- [Volunteers welcome!](Volunteers-welcome!.md)
11+
- [Translating the app](Translating-the-app.md)
12+
13+
### 📱 App Information
14+
15+
Documentation about the App itself, not the implementation:
16+
17+
* [Screen Structure](Screen-structure.md)
18+
* [Tutorial for new users](Tutorial-for-new-users.md)
19+
* [App Functionality](App-functionality.md)
20+
* [Frequently Asked Questions](Frequently-Asked-Questions.md)
21+
22+
### 👩‍💻 Developer Documentation
23+
24+
- [Contributing Guidelines](Contributing-Guidelines.md)
25+
- [Quick start guide for developers](Quick-start-guide-for-Developers.md)
26+
- [Developer workflow](Developer-workflow.md)
27+
- [Code Style](Code-style.md)
28+
- [Libraries used](Libraries-used.md)
29+
- [Project Maintenance](Project-maintenance.md)
30+
- [Software design document](Software-design-document.md)
31+
32+
#### 🔧 Implementation
33+
34+
* [Technical Overview](Technical-Overview.md)
35+
* [Code walkthrough for new devs (draft)](Code-walkthrough-for-new-devs-(draft).md)
36+
* [Category suggestions (readme)](Category-suggestions-(readme).md)
37+
* [External APIs](External-APIs.md)
38+
* [Code Structure](Code-Structure.md)
39+
* [On Device Storage](On-Device-Storage.md)
40+
41+
### 🧪 API testing:
42+
43+
- [Fuzzy category search](Fuzzy-category-search.md)
44+
- [Location based category search](Location-based-category-search.md)
45+
46+
### 🚀 Publish
47+
48+
- [Google Play store listing](Google-Play-store-listing.md)
49+
50+
<!-- This is copied across README.md, ios/README.md, android/README.md - please keep them in sync! -->
51+
## 🙌 Improving the docs
52+
53+
We appreciate any improvements you can make to the docs! Feel free to open pull requests with proposed changes and tag us for review.
54+
55+
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.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

ios/README.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# 📓 iOS Documentation
2+
3+
This will hold information on the Wikimedia Commons iOS app.
4+
5+
<!-- This is copied across README.md, ios/README.md, android/README.md - please keep them in sync! -->
6+
## 🙌 Improving the docs
7+
8+
We appreciate any improvements you can make to the docs! Feel free to open pull requests with proposed changes and tag us for review.
9+
10+
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.

0 commit comments

Comments
 (0)