From eaea7dd21da7b05f8da33c5534c88aebf1d2a72c Mon Sep 17 00:00:00 2001
From: osbm <osbm@osbm.dev>
Date: Tue, 4 Nov 2025 10:04:41 +0300
Subject: [PATCH] documentation improvement

---
 README.md                       | 27 ---------------------------
 docs/src/SUMMARY.md             |  3 +++
 docs/src/functional-coverage.md | 27 +++++++++++++++++++++++++++
 docs/src/roadmap.md             | 30 ++++++++++++++++++++++++++++++
 4 files changed, 60 insertions(+), 27 deletions(-)
 create mode 100644 docs/src/functional-coverage.md
 create mode 100644 docs/src/roadmap.md

diff --git a/README.md b/README.md
index fd9f640..13499c5 100644
--- a/README.md
+++ b/README.md
@@ -8,33 +8,6 @@ $ nix build --print-out-paths github:osbm/nixapks#smouldering_durtles
 /nix/store/z796iq87azckb8nsajpv43g7ybadq47s-smouldering_durtles-1.2.3.apk
 ```
 
-# Todo
-
-- [ ] After adding 10 different apps (they all can be successfully built) ask to migrate this repo to the nix-community org.
-- [x] Add CI that builds all apps on every commit.
-- [ ] Add first flutter app.
-- [ ] Add first react-native app.
-- [ ] Add first ionic app.
-- [x] Add documentation on github pages.
-- [ ] Add binary cache
-- [ ] Design a proper meta field for the needs of android apps.
-    - [ ] description
-    - [ ] license
-    - [ ] main page
-    - [ ] maintainers
-    - [ ] minSdkVersion (explain what is this)
-    - [ ] targetSdkVersion (explain what is this)
-    - [ ] abi (list of supported abis: armeabi-v7a, arm64-v8a, x86, x86_64)
-    - [ ] packageName (the unique identifier of the app, e.g. com.example.app)
-
-## Create checks
-
-- [ ] Check if the apk can be installed (hopefully on multiple architectures)
-- [ ] Check the meta field
-- [ ] Check if the output derivation has any runtime dependencies (it should not)
-- [ ] Check if the app got an update (maybe from fdroid or github releases) and create a PR automatically.
-
-
 
 
 # Notes
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
index a034c46..5184989 100644
--- a/docs/src/SUMMARY.md
+++ b/docs/src/SUMMARY.md
@@ -9,6 +9,9 @@
 - [Adding a New App](adding-a-new-app.md)
 - [Updating an App](updating-an-app.md)
 - [Derivation Metadata](derivation-metadata.md)
+- [Roadmap](roadmap.md)
+- [Basic Functional Coverage](functional-coverage.md)
+
 <!--
 # Android Development with Nix
 
diff --git a/docs/src/functional-coverage.md b/docs/src/functional-coverage.md
new file mode 100644
index 0000000..ba9ffc1
--- /dev/null
+++ b/docs/src/functional-coverage.md
@@ -0,0 +1,27 @@
+
+# BASIC FUNCTIONAL COVERAGE
+
+The idea is that we should be able to have all the basic functionalities of a smartphone just by using Free and Open Source Software (FOSS) applications available in this repository. 1 app per functionality is enough for now.
+
+- Phone (dialling / contacts)
+- Messaging / SMS
+- Mail / email
+- Browser / web access
+- Calendar / scheduling
+- Clock / alarms & timers
+- Calculator / conversions
+    - [x] Fossify-Calculator
+- Settings / device control & preferences
+- File manager / storage browser
+- Gallery / photos & media
+- Camera
+- Games & entertainment
+- Productivity / notes / to-do
+    - [x] Fossify-Notes
+- Networking / VPN
+- Media player / video playback
+- Music player / audio playback
+- Social / communication (chat, video calls)
+- Off grid communication
+- Navigation / maps / GPS
+
diff --git a/docs/src/roadmap.md b/docs/src/roadmap.md
new file mode 100644
index 0000000..0d9a0c4
--- /dev/null
+++ b/docs/src/roadmap.md
@@ -0,0 +1,30 @@
+
+
+# ROADMAP
+
+The thing is, I am a very shitty developer. And my capabilities are extremely limited. But I am ambitious so nix is perfect for me 😭.
+
+- [x] Add CI that builds all apps on every commit.
+- [ ] Add first flutter app.
+- [ ] Add first react-native app.
+- [ ] Add first ionic app.
+- [ ] Design a proper meta field for the needs of android apps.
+    - [x] description
+    - [x] license
+    - [x] main page
+    - [x] maintainers
+    - [ ] minSdkVersion (explain what is this)
+    - [ ] targetSdkVersion (explain what is this)
+    - [ ] abi (list of supported abis: armeabi-v7a, arm64-v8a, x86, x86_64)
+    - [ ] packageName (the unique identifier of the app, e.g. com.example.app)
+- [ ] Support building apps on more platforms (currently only x86_64-linux is supported)
+- [ ] After adding 10 different apps (they all must be successfully built) ask to migrate this repo to the nix-community github organization.
+- [ ] Have base functional coverage [See functional-coverage](functional-coverage.md)
+- [ ] Check if the apk can be installed (hopefully on multiple architectures)
+- [ ] Check the meta field
+- [ ] Check if the output derivation has any runtime dependencies (it should not)
+- [ ] Check if the app got an update (maybe from fdroid or github releases) and create a PR automatically.
+- [x] Add documentation on github pages.
+- [ ] Add binary cache
+- [ ] Prepare reproducibility report
+- [ ] Compile an application without using any maven repository (fetch all dependencies from their respective sources and compile them into jar files and feed the resulting jars to the apk build process) (this is probably impossible but worth a try)
\ No newline at end of file