Merge branch 'develop' into feature/bca/configurable_synctimeout_for_test

.github/ISSUE_TEMPLATE/bug.yml

@@ -73,3 +73,14 @@ body:
         - 'No'
     validations:
       required: true
+  - type: dropdown
+    id: pr
+    attributes:
+      label: Are you willing to provide a PR?
+      description:  |
+        Providing a PR can drastically speed up the process of fixing this bug. Don't worry, it's still OK to answer 'No' :).
+      options:
+        - 'Yes'
+        - 'No'
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -34,3 +34,14 @@ body:
       placeholder: Is there anything else you'd like to add?
     validations:
       required: false
+  - type: dropdown
+    id: pr
+    attributes:
+      label: Are you willing to provide a PR?
+      description:  |
+        Don't worry, it's still OK to answer 'No' :).
+      options:
+        - 'Yes'
+        - 'No'
+    validations:
+      required: true

.github/workflows/build.yml

@@ -67,4 +67,4 @@ jobs:
           path: |
             vector/build/outputs/apk/*/release/*.apk
 
-# TODO: add exodus checks
+# TODO add exodus checks

.github/workflows/post-pr.yml

@@ -325,5 +325,5 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           hookshot_url: ${{ secrets.ELEMENT_ANDROID_HOOKSHOT_URL }}
-          text_template: "Post-merge validation of ${{ github.head_ref }} into ${{ github.base_ref }} by ${{ github.event.merged_by }} failed: {{#each job_statuses }}{{#with this }}{{#if completed }}  {{name}} {{conclusion}} at {{completed_at}}, {{/if}}{{/with}}{{/each}}"
-          html_template: "Post-merge validation of ${{ github.head_ref }} into ${{ github.base_ref }} by ${{ github.event.merged_by }} failed: {{#each job_statuses }}{{#with this }}{{#if completed }}<br />{{icon conclusion}} {{name}} <font color='{{color conclusion}}'>{{conclusion}} at {{completed_at}} <a href=\"{{html_url}}\">[details]</a></font>{{/if}}{{/with}}{{/each}}"
+          text_template: "Post-merge validation of ${{ github.head_ref }} into ${{ github.base_ref }} by ${{ github.event.pull_request.merged_by.login }} failed: {{#each job_statuses }}{{#with this }}{{#if completed }}  {{name}} {{conclusion}} at {{completed_at}}, {{/if}}{{/with}}{{/each}}"
+          html_template: "Post-merge validation of ${{ github.head_ref }} into ${{ github.base_ref }} by ${{ github.event.pull_request.merged_by.login }} failed: {{#each job_statuses }}{{#with this }}{{#if completed }}<br />{{icon conclusion}} {{name}} <font color='{{color conclusion}}'>{{conclusion}} at {{completed_at}} <a href=\"{{html_url}}\">[details]</a></font>{{/if}}{{/with}}{{/each}}"

.github/workflows/quality.yml

@@ -5,6 +5,11 @@ on:
   push:
     branches: [ main, develop ]
 
+# Enrich gradle.properties for CI/CD
+env:
+  CI_GRADLE_ARG_PROPERTIES: >
+    -Porg.gradle.jvmargs=-Xmx4g
+
 jobs:
   check:
     name: Project Check Suite
@@ -14,6 +19,16 @@ jobs:
       - name: Run code quality check suite
         run: ./tools/check/check_code_quality.sh
 
+# Knit for all the modules (https://github.com/Kotlin/kotlinx-knit)
+  knit:
+    name: Knit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Run knit
+        run: |
+          ./gradlew knit
+
 # ktlint for all the modules
   ktlint:
     name: Kotlin Linter
@@ -87,6 +102,25 @@ jobs:
               comment_id: ${{ steps.fc.outputs.comment-id }}
             })
 
+# Gradle dependency analysis using https://github.com/autonomousapps/dependency-analysis-android-gradle-plugin
+  dependency-analysis:
+    name: Dependency analysis
+    runs-on: ubuntu-latest
+    # Allow all jobs on main and develop. Just one per PR.
+    concurrency:
+      group: ${{ github.ref == 'refs/heads/main' && format('dep-main-{0}', github.sha) || github.ref == 'refs/heads/develop' && format('dep-develop-{0}', github.sha) || format('dep-{0}', github.ref) }}
+      cancel-in-progress: true
+    steps:
+      - uses: actions/checkout@v3
+      - name: Dependency analysis
+        run: ./gradlew buildHealth $CI_GRADLE_ARG_PROPERTIES
+      - name: Upload dependency analysis
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: dependency-analysis
+          path: build/reports/dependency-analysis/build-health-report.txt
+
 # Lint for main module
   android-lint:
     name: Android Linter
@@ -147,3 +181,23 @@ jobs:
           name: release-lint-report-${{ matrix.target }}
           path: |
             vector/build/reports/*.*
+
+  detekt:
+    name: Detekt Analysis
+    runs-on: ubuntu-latest
+    # Allow all jobs on main and develop. Just one per PR.
+    concurrency:
+      group: ${{ github.ref == 'refs/heads/main' && format('detekt-main-{0}', github.sha) || github.ref == 'refs/heads/develop' && format('detekt-develop-{0}', github.sha) || format('detekt-{0}', github.ref) }}
+      cancel-in-progress: true
+    steps:
+      - uses: actions/checkout@v3
+      - name: Run detekt
+        run: |
+          ./gradlew detekt
+      - name: Upload reports
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: detekt-report
+          path: |
+            */build/reports/detekt/detekt.html

CHANGES.md

@@ -1,3 +1,108 @@
+Changes in Element v1.4.18 (2022-05-31)
+=======================================
+
+Features ✨
+----------
+ - Space explore screen changes: removed space card, added rooms filtering ([#5658](https://github.com/vector-im/element-android/issues/5658))
+ - Adds space or user id as a subtitle under rooms in search ([#5860](https://github.com/vector-im/element-android/issues/5860))
+ - Adds up navigation in spaces ([#6073](https://github.com/vector-im/element-android/issues/6073))
+ - Labs flag for enabling live location sharing ([#6098](https://github.com/vector-im/element-android/issues/6098))
+ - Added support for mandatory backup or passphrase from .well-known configuration. ([#6133](https://github.com/vector-im/element-android/issues/6133))
+ - Security - Asking for user confirmation when tapping URLs which contain unicode directional overrides ([#6163](https://github.com/vector-im/element-android/issues/6163))
+ - Add settings switch to allow autoplaying animated images ([#6166](https://github.com/vector-im/element-android/issues/6166))
+ - Live Location Sharing - User List Bottom Sheet ([#6170](https://github.com/vector-im/element-android/issues/6170))
+
+Bugfixes 🐛
+----------
+ - Fix some notifications not clearing when read ([#4862](https://github.com/vector-im/element-android/issues/4862))
+ - Do not switch away from home space on notification when "Show all Rooms in Home" is selected. ([#5827](https://github.com/vector-im/element-android/issues/5827))
+ - Use fixed text size in read receipt counter ([#5856](https://github.com/vector-im/element-android/issues/5856))
+ - Revert: Use member name instead of room name in DM creation item ([#6032](https://github.com/vector-im/element-android/issues/6032))
+ - Poll refactoring with unit tests ([#6074](https://github.com/vector-im/element-android/issues/6074))
+ - Correct .well-known/matrix/client handling for server_names which include ports. ([#6095](https://github.com/vector-im/element-android/issues/6095))
+ - Glide - Use current drawable while loading new static map image ([#6103](https://github.com/vector-im/element-android/issues/6103))
+ - Fix sending multiple invites to a room reaching only one or two people ([#6109](https://github.com/vector-im/element-android/issues/6109))
+ - Prevent widget web view from reloading on screen / orientation change ([#6140](https://github.com/vector-im/element-android/issues/6140))
+ - Fix decrypting redacted event from sending errors ([#6148](https://github.com/vector-im/element-android/issues/6148))
+ - Make widget web view request system permissions for camera and microphone (PSF-1061) ([#6149](https://github.com/vector-im/element-android/issues/6149))
+
+In development 🚧
+----------------
+ - Adds email input and verification screens to the new FTUE onboarding flow ([#5278](https://github.com/vector-im/element-android/issues/5278))
+ - FTUE - Adds the redesigned Sign In screen ([#5283](https://github.com/vector-im/element-android/issues/5283))
+ - [Live location sharing] Update message in timeline during the live ([#5689](https://github.com/vector-im/element-android/issues/5689))
+ - FTUE - Overrides sign up flow ordering for matrix.org only ([#5783](https://github.com/vector-im/element-android/issues/5783))
+ - Live location sharing: navigation from timeline to map screen
+  Live location sharing: show user pins on map screen ([#6012](https://github.com/vector-im/element-android/issues/6012))
+ - FTUE - Adds homeserver login/register deeplink support ([#6023](https://github.com/vector-im/element-android/issues/6023))
+ - [Live location sharing] Update entity in DB when a live is timed out ([#6123](https://github.com/vector-im/element-android/issues/6123))
+
+SDK API changes ⚠️
+------------------
+- Notifies other devices when a verification request sent from an Android device is accepted.` ([#5724](https://github.com/vector-im/element-android/issues/5724))
+- Some `val` have been changed to `fun` to increase their visibility in the generated documentation. Just add `()` if you were using them.
+- `KeysBackupService.state` has been replaced by `KeysBackupService.getState()`
+- `KeysBackupService.isStucked` has been replaced by `KeysBackupService.isStuck()`
+- SDK documentation improved ([#5952](https://github.com/vector-im/element-android/issues/5952))
+- Improve replay attacks and reduce duplicate message index errors ([#6077](https://github.com/vector-im/element-android/issues/6077))
+- Remove `RoomSummaryQueryParams.roomId`. If you need to observe a single room, use the new API `RoomService.getRoomSummaryLive(roomId: String)`
+- `ActiveSpaceFilter` has been renamed to `SpaceFilter`
+- `RoomCategoryFilter.ALL` has been removed, just pass `null` to not filter on Room category. ([#6143](https://github.com/vector-im/element-android/issues/6143))
+
+Other changes
+-------------
+ - leaving space experience changed to be aligned with iOS ([#5728](https://github.com/vector-im/element-android/issues/5728))
+ - @Ignore a number of tests that are currently failing in CI. ([#6025](https://github.com/vector-im/element-android/issues/6025))
+ - Remove ShortcutBadger lib and usage (it was dead code) ([#6041](https://github.com/vector-im/element-android/issues/6041))
+ - Test: Ensure calling 'fail()' is not caught by the catch block ([#6089](https://github.com/vector-im/element-android/issues/6089))
+ - Excludes transitive optional non FOSS google location dependency from fdroid builds ([#6100](https://github.com/vector-im/element-android/issues/6100))
+ - Fixed grammar errors in /vector/src/main/res/values/strings.xml ([#6132](https://github.com/vector-im/element-android/issues/6132))
+ - Downgrade gradle from 7.2.0 to 7.1.3 ([#6141](https://github.com/vector-im/element-android/issues/6141))
+ - Add Lao language to the in-app settings. ([#6196](https://github.com/vector-im/element-android/issues/6196))
+ - Remove the background location permission request ([#6198](https://github.com/vector-im/element-android/issues/6198))
+
+
+Changes in Element v1.4.16 (2022-05-17)
+=======================================
+
+Features ✨
+----------
+ - Use key backup before requesting keys + refactor & improvement of key request/forward ([#5494](https://github.com/vector-im/element-android/issues/5494))
+ - Screen sharing over WebRTC ([#5911](https://github.com/vector-im/element-android/issues/5911))
+ - Allow using the latest user Avatar and name for all messages in the timeline ([#5932](https://github.com/vector-im/element-android/issues/5932))
+ - Added themed launch icons for Android 13 ([#5936](https://github.com/vector-im/element-android/issues/5936))
+ - Add presence indicator busy and away. ([#6047](https://github.com/vector-im/element-android/issues/6047))
+
+Bugfixes 🐛
+----------
+ - Changed copy and list order in member profile screen. ([#5825](https://github.com/vector-im/element-android/issues/5825))
+ - Fix for audio only being received in one direction after an un-hold during a sip call. ([#5865](https://github.com/vector-im/element-android/issues/5865))
+ - Desynchronized 4S | Megolm backup causing Unusable backup ([#5906](https://github.com/vector-im/element-android/issues/5906))
+ - If animations are disable on the System, chat effects and confetti will be disabled too ([#5941](https://github.com/vector-im/element-android/issues/5941))
+ - Multiple threads improvement (mainly UI) ([#5959](https://github.com/vector-im/element-android/issues/5959))
+
+Improved Documentation 📚
+------------------------
+ - Note public_baseurl requirement in integration tests documentation. ([#5973](https://github.com/vector-im/element-android/issues/5973))
+
+SDK API changes ⚠️
+------------------
+ - - New API to enable/disable key forwarding CryptoService#enableKeyGossiping()
+  - New API to limit room key request only to own devices MXCryptoConfig#limitRoomKeyRequestsToMyDevices
+  - Event Trail API has changed, now using AuditTrail events
+  - New API to manually accept an incoming key request CryptoService#manuallyAcceptRoomKeyRequest() ([#5559](https://github.com/vector-im/element-android/issues/5559))
+ - Small change in the Matrix class: deprecated methods have been removed and the constructor is now public. Also the fun `workerFactory()` has been renamed to `getWorkerFactory()` ([#5887](https://github.com/vector-im/element-android/issues/5887))
+ - Including SSL/TLS error handing when doing WellKnown lookups without a custom HomeServerConnectionConfig ([#5965](https://github.com/vector-im/element-android/issues/5965))
+
+Other changes
+-------------
+ - Improve threads rendering in the main timeline ([#5151](https://github.com/vector-im/element-android/issues/5151))
+ - Reformatted project code ([#5953](https://github.com/vector-im/element-android/issues/5953))
+ - Update check for server-side threads support to match spec. ([#5997](https://github.com/vector-im/element-android/issues/5997))
+ - Setup detekt ([#6038](https://github.com/vector-im/element-android/issues/6038))
+ - Notify the user for each new message ([#4632](https://github.com/vector-im/element-android/issues/4632))
+
+
 Changes in Element v1.4.14 (2022-05-05)
 =======================================
 

build.gradle

@@ -27,17 +27,23 @@ buildscript {
         classpath 'com.google.gms:google-services:4.3.10'
         classpath 'org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:3.3'
         classpath 'com.google.android.gms:oss-licenses-plugin:0.10.5'
-        classpath "com.likethesalad.android:stem-plugin:2.0.0"
+        classpath "com.likethesalad.android:stem-plugin:2.1.1"
         classpath 'org.owasp:dependency-check-gradle:7.1.0.1'
         classpath "org.jetbrains.dokka:dokka-gradle-plugin:1.6.21"
+        classpath "org.jetbrains.kotlinx:kotlinx-knit:0.4.0"
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }
 }
 
-// ktlint Plugin
 plugins {
+    // ktlint Plugin
     id "org.jlleitschuh.gradle.ktlint" version "10.3.0"
+    // Detekt
+    id "io.gitlab.arturbosch.detekt" version "1.20.0"
+
+    // Dependency Analysis
+    id 'com.autonomousapps.dependency-analysis' version "1.4.0"
 }
 
 // https://github.com/jeremylong/DependencyCheck
@@ -52,6 +58,7 @@ dependencyCheck {
 
 allprojects {
     apply plugin: "org.jlleitschuh.gradle.ktlint"
+    apply plugin: "io.gitlab.arturbosch.detekt"
 
     repositories {
         // Do not use `mavenCentral()`, it prevents Dependabot from working properly
@@ -119,7 +126,7 @@ allprojects {
         // display the corresponding rule
         verbose = true
         disabledRules = [
-                // TODO: Re-enable these 4 rules after reformatting project
+                // TODO Re-enable these 4 rules after reformatting project
                 "indent",
                 "experimental:argument-list-wrapping",
                 "max-line-length",
@@ -140,6 +147,15 @@ allprojects {
                 "experimental:kdoc-wrapping",
         ]
     }
+
+    detekt {
+        // preconfigure defaults
+        buildUponDefaultConfig = true
+        // activate all available (even unstable) rules.
+        allRules = true
+        // point to your custom config defining rules to run, overwriting default behavior
+        config = files("$rootDir/tools/detekt/detekt.yml")
+    }
 }
 
 task clean(type: Delete) {
@@ -206,3 +222,61 @@ project(":library:diff-match-patch") {
 //        }
 //    }
 //}
+
+dependencyAnalysis {
+    dependencies {
+        bundle("kotlin-stdlib") {
+            includeGroup("org.jetbrains.kotlin")
+        }
+        bundle("react") {
+            includeGroup("com.facebook.react")
+        }
+    }
+    issues {
+        all {
+            ignoreKtx(true)
+            onUsedTransitiveDependencies {
+                // Transitively used dependencies that should be declared directly
+                severity("ignore")
+            }
+            onUnusedDependencies {
+                severity("fail")
+            }
+            onUnusedAnnotationProcessors {
+                severity("fail")
+                exclude("com.airbnb.android:epoxy-processor", "com.google.dagger:hilt-compiler") // False positives
+            }
+        }
+        project(":library:jsonviewer") {
+            onUnusedDependencies {
+                exclude("org.json:json") // Used in unit tests, overwrites the one bundled into Android
+            }
+        }
+        project(":library:ui-styles") {
+            onUnusedDependencies {
+                exclude("com.github.vector-im:PFLockScreen-Android") // False positive
+            }
+        }
+        project(":matrix-sdk-android") {
+            onUnusedDependencies {
+                exclude("io.reactivex.rxjava2:rxkotlin") // Transitively required for mocking realm as monarchy doesn't expose Rx
+            }
+        }
+        project(":matrix-sdk-android-flow") {
+            onUnusedDependencies {
+                exclude("androidx.paging:paging-runtime-ktx") // False positive
+            }
+        }
+        project(":vector") {
+            onUnusedDependencies {
+                // False positives
+                exclude(
+                        "com.vanniktech:emoji-google",
+                        "com.vanniktech:emoji-material",
+                        "org.maplibre.gl:android-plugin-annotation-v9",
+                        "org.maplibre.gl:android-sdk",
+                )
+            }
+        }
+    }
+}

changelog.d/46312.misc

@@ -1 +0,0 @@
-Notify the user for each new message

changelog.d/5151.misc

@@ -1 +0,0 @@
-Improve threads rendering in the main timeline

changelog.d/5494.feature

@@ -1 +0,0 @@
-Use key backup before requesting keys + refactor & improvement of key request/forward

changelog.d/5559.sdk

@@ -1,4 +0,0 @@
-- New API to enable/disable key forwarding CryptoService#enableKeyGossiping()
-- New API to limit room key request only to own devices MXCryptoConfig#limitRoomKeyRequestsToMyDevices
-- Event Trail API has changed, now using AuditTrail events
-- New API to manually accept an incoming key request CryptoService#manuallyAcceptRoomKeyRequest()

changelog.d/5825.bugfix

@@ -1 +0,0 @@
-Changed copy and list order in member profile screen.

changelog.d/5906.bugfix

@@ -1 +0,0 @@
-Desynchronized 4S | Megolm backup causing Unusable backup

changelog.d/5911.feature

@@ -1 +0,0 @@
-Screen sharing over WebRTC

changelog.d/5932.feature

@@ -1 +0,0 @@
-Allow using the latest user Avatar and name for all messages in the timeline

changelog.d/5936.feature

@@ -1 +0,0 @@
-Added themed launch icons for Android 13

changelog.d/5941.bugfix

@@ -1 +0,0 @@
-If animations are disable on the System, chat effects and confetti will be disabled too

changelog.d/5953.misc

@@ -1 +0,0 @@
-Reformatted project code

changelog.d/5965.sdk

@@ -1 +0,0 @@
-Including SSL/TLS error handing when doing WellKnown lookups without a custom HomeServerConnectionConfig

changelog.d/5997.misc

@@ -1 +0,0 @@
-Update check for server-side threads support to match spec.

dependencies.gradle

@@ -7,10 +7,13 @@ ext.versions = [
         'targetCompat'      : JavaVersion.VERSION_11,
 ]
 
-def gradle = "7.2.0"
+
+// Pinned to 7.1.3 because of https://github.com/vector-im/element-android/issues/6142
+// Please test carefully before upgrading again.
+def gradle = "7.1.3"
 // Ref: https://kotlinlang.org/releases.html
 def kotlin = "1.6.21"
-def kotlinCoroutines = "1.6.0"
+def kotlinCoroutines = "1.6.2"
 def dagger = "2.42"
 def retrofit = "2.9.0"
 def arrow = "0.8.2"
@@ -23,7 +26,7 @@ def mavericks = "2.6.1"
 def glide = "4.13.2"
 def bigImageViewer = "1.8.1"
 def jjwt = "0.11.5"
-def vanniktechEmoji = "0.9.0"
+def vanniktechEmoji = "0.15.0"
 
 // Testing
 def mockk = "1.12.4"
@@ -45,12 +48,13 @@ ext.libs = [
                 'coroutinesTest'          : "org.jetbrains.kotlinx:kotlinx-coroutines-test:$kotlinCoroutines"
         ],
         androidx    : [
+                'activity'                : "androidx.activity:activity:1.4.0",
                 'appCompat'               : "androidx.appcompat:appcompat:1.4.1",
                 'core'                    : "androidx.core:core-ktx:1.7.0",
                 'recyclerview'            : "androidx.recyclerview:recyclerview:1.2.1",
                 'exifinterface'           : "androidx.exifinterface:exifinterface:1.3.3",
                 'fragmentKtx'             : "androidx.fragment:fragment-ktx:1.4.1",
-                'constraintLayout'        : "androidx.constraintlayout:constraintlayout:2.1.3",
+                'constraintLayout'        : "androidx.constraintlayout:constraintlayout:2.1.4",
                 'work'                    : "androidx.work:work-runtime-ktx:2.7.1",
                 'autoFill'                : "androidx.autofill:autofill:1.1.0",
                 'preferenceKtx'           : "androidx.preference:preference-ktx:1.2.0",
@@ -69,7 +73,9 @@ ext.libs = [
                 'testRules'               : "androidx.test:rules:$androidxTest",
                 'espressoCore'            : "androidx.test.espresso:espresso-core:$espresso",
                 'espressoContrib'         : "androidx.test.espresso:espresso-contrib:$espresso",
-                'espressoIntents'         : "androidx.test.espresso:espresso-intents:$espresso"
+                'espressoIntents'         : "androidx.test.espresso:espresso-intents:$espresso",
+                'viewpager2'              : "androidx.viewpager2:viewpager2:1.0.0",
+                'transition'              : "androidx.transition:transition:1.2.0",
         ],
         google      : [
                 'material'                : "com.google.android.material:material:1.6.0"
@@ -81,7 +87,7 @@ ext.libs = [
                 'hiltCompiler'            : "com.google.dagger:hilt-compiler:$dagger"
         ],
         squareup    : [
-                'moshi'                  : "com.squareup.moshi:moshi-adapters:$moshi",
+                'moshi'                  : "com.squareup.moshi:moshi:$moshi",
                 'moshiKotlin'            : "com.squareup.moshi:moshi-kotlin-codegen:$moshi",
                 'retrofit'               : "com.squareup.retrofit2:retrofit:$retrofit",
                 'retrofitMoshi'          : "com.squareup.retrofit2:converter-moshi:$retrofit"
@@ -107,6 +113,10 @@ ext.libs = [
                 'mavericks'              : "com.airbnb.android:mavericks:$mavericks",
                 'mavericksTesting'       : "com.airbnb.android:mavericks-testing:$mavericks"
         ],
+        maplibre    : [
+                'androidSdk'             : "org.maplibre.gl:android-sdk:9.5.2",
+                'pluginAnnotation'       : "org.maplibre.gl:android-plugin-annotation-v9:1.0.0"
+        ],
         mockk      : [
                 'mockk'                   : "io.mockk:mockk:$mockk",
                 'mockkAndroid'            : "io.mockk:mockk-android:$mockk"

dependencies_groups.gradle

@@ -123,6 +123,7 @@ ext.groups = [
                         'io.github.detekt.sarif4k',
                         'io.github.microutils',
                         'io.github.reactivecircus.flowbinding',
+                        'io.gitlab.arturbosch.detekt',
                         'io.grpc',
                         'io.jsonwebtoken',
                         'io.kindedj',
@@ -140,7 +141,6 @@ ext.groups = [
                         'jline',
                         'jp.wasabeef',
                         'junit',
-                        'me.leolin',
                         'me.saket',
                         'net.bytebuddy',
                         'net.java',
@@ -195,6 +195,7 @@ ext.groups = [
                         'org.testng',
                         'org.threeten',
                         'org.webjars',
+                        'org.yaml',
                         'ru.noties',
                         'xerces',
                         'xml-apis',

docs/add_threePids.md

@@ -1,5 +1,34 @@
 # Adding and removing ThreePids to an account
 
+<!--- TOC -->
+
+* [Add email](#add-email)
+  * [User enter the email](#user-enter-the-email)
+    * [The email is already added to an account](#the-email-is-already-added-to-an-account)
+    * [The email is free](#the-email-is-free)
+* [User receives an e-mail](#user-receives-an-e-mail)
+  * [User clicks on the link](#user-clicks-on-the-link)
+  * [User returns on Element](#user-returns-on-element)
+  * [User enters his password](#user-enters-his-password)
+    * [The link has not been clicked](#the-link-has-not-been-clicked)
+    * [Wrong password](#wrong-password)
+    * [The link has been clicked and the account password is correct](#the-link-has-been-clicked-and-the-account-password-is-correct)
+* [Remove email](#remove-email)
+  * [User want to remove an email from his account](#user-want-to-remove-an-email-from-his-account)
+    * [Email was not bound to an identity server](#email-was-not-bound-to-an-identity-server)
+    * [Email was bound to an identity server](#email-was-bound-to-an-identity-server)
+* [Add phone number](#add-phone-number)
+    * [The phone number is already added to an account](#the-phone-number-is-already-added-to-an-account)
+    * [The phone number is free](#the-phone-number-is-free)
+* [User receive a text message](#user-receive-a-text-message)
+  * [User enter the code to the app](#user-enter-the-code-to-the-app)
+    * [Wrong code](#wrong-code)
+    * [Correct code](#correct-code)
+* [Remove phone number](#remove-phone-number)
+  * [User wants to remove a phone number from his account](#user-wants-to-remove-a-phone-number-from-his-account)
+
+<!--- END -->
+
 ## Add email
 
 ### User enter the email
@@ -37,9 +66,9 @@ Wording: "We've sent you an email to verify your address. Please follow the inst
 }
 ```
 
-## User receive an e-mail
+## User receives an e-mail
 
-> [homeserver.org] Validate your email
+> `homeserver.org` Validate your email
 >
 > A request to add an email address to your Matrix account has been received. If this was you, please click the link below to confirm adding this email:
   https://homeserver.org/_matrix/client/unstable/add_threepid/email/submit_token?token=WUnEhQAmJrXupdEbXgdWvnVIKaGYZFsU&client_secret=TixzvOnw7nLEUdiQEmkHzkXKrY4HhiGh&sid=bxyDHuJKsdkjMlTJ

docs/analytics.md

@@ -1,5 +1,13 @@
 # Analytics in Element
 
+<!--- TOC -->
+
+* [Solution](#solution)
+* [How to add a new Event](#how-to-add-a-new-event)
+* [Forks of Element](#forks-of-element)
+
+<!--- END -->
+
 ## Solution
 
 Element is using PostHog to send analytics event.

docs/color_migration_guide.md

@@ -1,5 +1,14 @@
 # Color migration
 
+<!--- TOC -->
+
+  * [Changes](#changes)
+  * [Main change for developers](#main-change-for-developers)
+  * [Remaining work](#remaining-work)
+  * [Migration guide](#migration-guide)
+
+<!--- END -->
+
 ### Changes
 
 - use colors defined in https://www.figma.com/file/X4XTH9iS2KGJ2wFKDqkyed/Compound?node-id=557%3A0

docs/design.md

@@ -1,5 +1,31 @@
 # Element Android design
 
+<!--- TOC -->
+
+* [Introduction](#introduction)
+* [How to import from Figma to the Element Android project](#how-to-import-from-figma-to-the-element-android-project)
+  * [Colors](#colors)
+  * [Text](#text)
+  * [Dimension, position and margin](#dimension-position-and-margin)
+  * [Icons](#icons)
+    * [Export drawable from Figma](#export-drawable-from-figma)
+    * [Import in Android Studio](#import-in-android-studio)
+  * [Images](#images)
+* [Figma links](#figma-links)
+  * [Coumpound](#coumpound)
+  * [Login](#login)
+    * [Login v2](#login-v2)
+  * [Room list](#room-list)
+  * [Timeline](#timeline)
+  * [Voice message](#voice-message)
+  * [Room settings](#room-settings)
+  * [VoIP](#voip)
+  * [Presence](#presence)
+  * [Spaces](#spaces)
+  * [List to be continued...](#list-to-be-continued)
+
+<!--- END -->
+
 ## Introduction
 
 Design at element.io is done using Figma - https://www.figma.com

docs/identity_server.md

@@ -1,5 +1,19 @@
 # Identity server
 
+<!--- TOC -->
+
+* [Introduction](#introduction)
+* [Implementation](#implementation)
+* [Related MSCs](#related-mscs)
+* [Steps and requirements](#steps-and-requirements)
+* [Screens](#screens)
+  * [Settings](#settings)
+  * [Discovery screen](#discovery-screen)
+  * [Set identity server screen](#set-identity-server-screen)
+* [Ref:](#ref:)
+
+<!--- END -->
+
 Issue: #607
 PR: #1354
 

docs/integration_tests.md

@@ -1,5 +1,18 @@
 # Integration tests
 
+<!--- TOC -->
+
+* [Pre requirements](#pre-requirements)
+* [Install and run Synapse](#install-and-run-synapse)
+* [Run the test](#run-the-test)
+* [Stop Synapse](#stop-synapse)
+* [Troubleshoot](#troubleshoot)
+  * [Android Emulator does cannot reach the homeserver](#android-emulator-does-cannot-reach-the-homeserver)
+  * [Tests partially run but some fail with "Unable to contact localhost:8080"](#tests-partially-run-but-some-fail-with-"unable-to-contact-localhost:8080")
+  * [virtualenv command fails](#virtualenv-command-fails)
+
+<!--- END -->
+
 Integration tests are useful to ensure that the code works well for any use cases.
 
 They can also be used as sample on how to use the Matrix SDK.
@@ -43,14 +56,17 @@ virtualenv -p python3 env
 source env/bin/activate
 pip install -e .
 demo/start.sh --no-rate-limit
+
 ```
 
-Alternatively, to install the latest Synapse release package (and not a cloned branch) you can run the following instead of `pip install -e .`:
+Alternatively, to install the latest Synapse release package (and not a cloned branch) you can run the following instead of `git clone` and `pip install -e .`:
 
 ```bash
 pip install matrix-synapse
 ```
 
+On your first run, you will want to stop the demo and edit the config to correct the `public_baseurl` to http://10.0.2.2:8080 and restart the server.
+
 You should now have 3 running federated Synapse instances 🎉, at http://127.0.0.1:8080/, http://127.0.0.1:8081/ and  http://127.0.0.1:8082/, which should display a "It Works! Synapse is running" message.
 
 ## Run the test
@@ -87,6 +103,18 @@ You'll need python3 to be able to run synapse
 
 Try on the Emulator browser to open "http://10.0.2.2:8080". You should see the "Synapse is running" message.
 
+### Tests partially run but some fail with "Unable to contact localhost:8080"
+
+This is because the `public_baseurl` of synapse is not consistent with the endpoint that the tests are connecting to.
+
+Ensure you have the following configuration in `demo/etc/8080.config`.
+
+```
+public_baseurl: http://10.0.2.2:8080/
+```
+
+After changing this you will need to restart synapse using `demo/stop.sh` and `demo/start.sh` to load the new configuration.
+
 ### virtualenv command fails
 
 You can try using

docs/jitsi.md

@@ -1,20 +1,32 @@
 # Jitsi in Element Android
 
+<!--- TOC -->
+
+* [Native Jitsi SDK](#native-jitsi-sdk)
+  * [How to build the Jitsi Meet SDK](#how-to-build-the-jitsi-meet-sdk)
+    * [Jitsi version](#jitsi-version)
+    * [Run the build script](#run-the-build-script)
+    * [Link with the new generated library](#link-with-the-new-generated-library)
+    * [Sanity tests](#sanity-tests)
+    * [Export the build library](#export-the-build-library)
+
+<!--- END -->
+
 Native Jitsi support has been added to Element Android by the PR [#1914](https://github.com/vector-im/element-android/pull/1914). The description of the PR contains some documentation about the behaviour in each possible room configuration.
 
 Also, ensure to have a look on [the documentation from Element Web](https://github.com/vector-im/element-web/blob/develop/docs/jitsi.md)
 
 The official documentation about how to integrate the Jitsi SDK in an Android app is available here: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-android-sdk.
 
-# Native Jitsi SDK
+## Native Jitsi SDK
 
 The Jitsi SDK is built by ourselves with the flag LIBRE_BUILD, to be able to be integrated on the F-Droid version of Element Android.
 
 The generated maven repository is then host in the project https://github.com/vector-im/jitsi_libre_maven
 
-## How to build the Jitsi Meet SDK
+### How to build the Jitsi Meet SDK
 
-### Jitsi version
+#### Jitsi version
 
 Update the script `./tools/jitsi/build_jisti_libs.sh` with the tag of the project `https://github.com/jitsi/jitsi-meet`.
 
@@ -22,7 +34,7 @@ Latest tag can be found from this page: https://github.com/jitsi/jitsi-meet-rele
 
 Currently we are building the version with the tag `android-sdk-3.10.0`.
 
-### Run the build script
+#### Run the build script
 
 At the root of the Element Android, run the following script:
 
@@ -32,7 +44,7 @@ At the root of the Element Android, run the following script:
 
 It will build the Jitsi Meet Android library and put every generated files in the folder `/tmp/jitsi`
 
-### Link with the new generated library
+#### Link with the new generated library
 
 - Update the file `./build.gradle` to use the previously created local Maven repository. Currently we have this line:
 
@@ -57,7 +69,7 @@ implementation('com.facebook.react:react-native-webrtc:1.92.1-jitsi-9093212@aar'
 - Perform a gradle sync and build the project
 - Perform test
 
-### Sanity tests
+#### Sanity tests
 
 In order to validate that the upgrade of the Jitsi and WebRTC dependency does not break anything, the following sanity tests have to be performed, using two devices:
 - Make 1-1 audio call (so using WebRTC)
@@ -65,7 +77,7 @@ In order to validate that the upgrade of the Jitsi and WebRTC dependency does no
 - Create and join a conference call with audio only (so using Jitsi library). Leave the conference. Join it again.
 - Create and join a conference call with audio and video (so using Jitsi library) Leave the conference. Join it again.
 
-### Export the build library
+#### Export the build library
 
 If all the tests are passed, you can export the generated Jitsi library to our Maven repository.
 
@@ -81,4 +93,4 @@ url "https://github.com/vector-im/jitsi_libre_maven/raw/master/android-sdk-3.10.
 
 - Build the project and perform the sanity tests again.
 
-- Update the file `/CHANGES.md` to notify about the library upgrade, and create a regular PR for project Element Android.
+- Update the file `/CHANGES.md` to notify about the library upgrade, and create a regular PR for project Element Android.

docs/notifications.md

@@ -1,37 +1,42 @@
 This document aims to describe how Element android displays notifications to the end user. It also clarifies notifications and background settings in the app.
 
 # Table of Contents
-1. [Prerequisites Knowledge](#prerequisites-knowledge)
-    * [How does a matrix client get a message from a homeserver?](#how-does-a-matrix-client-get-a-message-from-a-homeserver)
-    * [How does a mobile app receives push notification?](#how-does-a-mobile-app-receives-push-notification)
-    * [Push VS Notification](#push-vs-notification)
-    * [Push in the matrix federated world](#push-in-the-matrix-federated-world)
-    * [How does the homeserver know when to notify a client?](#how-does-the-homeserver-know-when-to-notify-a-client)
-    * [Push vs privacy, and mitigation](#push-vs-privacy-and-mitigation)
-    * [Background processing limitations](#background-processing-limitations)
-2. [Element Notification implementations](#element-notification-implementations)
-    * [Requirements](#requirements) 
-    * [Foreground sync mode (Gplay & F-Droid)](#foreground-sync-mode-gplay-f-droid)
-    * [Push (FCM) received in background](#push-fcm-received-in-background)
-    * [FCM Fallback mode](#fcm-fallback-mode)
-    * [F-Droid background Mode](#f-droid-background-mode)
-3. [Application Settings](#application-settings)
+
+<!--- TOC -->
+
+* [Prerequisites Knowledge](#prerequisites-knowledge)
+  * [How does a matrix client get a message from a homeserver?](#how-does-a-matrix-client-get-a-message-from-a-homeserver?)
+  * [How does a mobile app receives push notification](#how-does-a-mobile-app-receives-push-notification)
+  * [Push VS Notification](#push-vs-notification)
+  * [Push in the matrix federated world](#push-in-the-matrix-federated-world)
+  * [How does the homeserver know when to notify a client?](#how-does-the-homeserver-know-when-to-notify-a-client?)
+  * [Push vs privacy, and mitigation](#push-vs-privacy-and-mitigation)
+  * [Background processing limitations](#background-processing-limitations)
+* [Element Notification implementations](#element-notification-implementations)
+  * [Requirements](#requirements)
+  * [Foreground sync mode (Gplay and F-Droid)](#foreground-sync-mode-gplay-and-f-droid)
+  * [Push (FCM) received in background](#push-fcm-received-in-background)
+  * [FCM Fallback mode](#fcm-fallback-mode)
+  * [F-Droid background Mode](#f-droid-background-mode)
+* [Application Settings](#application-settings)
+
+<!--- END -->
 
 
 First let's start with some prerequisite knowledge
 
-# Prerequisites Knowledge
+## Prerequisites Knowledge
 
-## How does a matrix client get a message from a homeserver?
+### How does a matrix client get a message from a homeserver?
 
 In order to get messages from a homeserver, a matrix client need to perform a ``sync`` operation.
 
 `To read events, the intended flow of operation is for clients to first call the /sync API without a since parameter. This returns the most recent message events for each room, as well as the state of the room at the start of the returned timeline. `
 
-The client need to call the `sync`API periodically in order to get incremental updates of the server state (new messages).
+The client need to call the `sync` API periodically in order to get incremental updates of the server state (new messages).
 This mechanism is known as **HTTP long Polling**.
 
-Using the **HTTP Long Polling** mechanism  a client polls a server requesting new information.
+Using the **HTTP Long Polling** mechanism a client polls a server requesting new information.
 The server *holds the request open until new data is available*.
 Once available, the server responds and sends the new information.
 When the client receives the new information, it immediately sends another request, and the operation is repeated.
@@ -52,7 +57,7 @@ By default, this is 0, so the server will return immediately even if the respons
 
 When the Element Android app is open (i.e in foreground state), the default timeout is 30 seconds, and delay is 0.
 
-## How does a mobile app receives push notification
+### How does a mobile app receives push notification
 
 Push notification is used as a way to wake up a mobile application when some important information is available and should be processed.
 
@@ -66,22 +71,22 @@ FCM will only work on android devices that have Google plays services installed
 (In simple terms, Google Play Services is a background service that runs on Android, which in turn helps in integrating Google’s advanced functionalities to other applications)
 
 De-Googlified devices need to rely on something else in order to stay up to date with a server.
-There some cases when devices with google services cannot use FCM (network infrastructure limitations -firewalls- ,
- privacy and or independency requirement, source code licence)
+There some cases when devices with google services cannot use FCM (network infrastructure limitations -firewalls-,
+ privacy and or independence requirement, source code licence)
 
-## Push VS Notification
+### Push VS Notification
 
 This need some disambiguation, because it is the source of common confusion:
 
 
-*The fact that you see a notification on your screen does not mean that you have successfully configured your PUSH plateform.*
+*The fact that you see a notification on your screen does not mean that you have successfully configured your PUSH platform.*
 
   Technically there is a difference between a push and a notification. A notification is what you see on screen and/or in the notification Menu/Drawer (in the top bar of the phone).
 
   Notifications are not always triggered by a push (One can display a notification locally triggered by an alarm)
 
 
-## Push in the matrix federated world
+### Push in the matrix federated world
 
 In order to send a push to a mobile, App developers need to have a server that will use the FCM APIs, and these APIs requires authentication!
 This server is called a **Push Gateway** in the matrix world
@@ -118,11 +123,11 @@ Client/Server API  +              |                    |  |      |            |
 ```
 
 Recommended reading:
- * https://thomask.sdf.org/blog/2016/12/11/riots-magical-push-notifications-in-ios.html
+* https://thomask.sdf.org/blog/2016/12/11/riots-magical-push-notifications-in-ios.html
 * https://matrix.org/docs/spec/client_server/r0.4.0.html#id128
 
 
-## How does the homeserver know when to notify a client?
+### How does the homeserver know when to notify a client?
 
 This is defined by [**push rules**](https://matrix.org/docs/spec/client_server/r0.4.0.html#push-rules-).
 
@@ -140,14 +145,14 @@ Of course, content patterns matching cannot be used for encrypted messages serve
 
 That is why clients are able to **process the push rules client side** to decide what kind of notification should be presented for a given event.
 
-## Push vs privacy, and mitigation
+### Push vs privacy, and mitigation
 
 As seen previously, App developers don't directly send a push to the end user's device, they use a Push Provider as intermediary. So technically this intermediary is able to read the content of what is sent.
 
 App developers usually mitigate this by sending a `silent notification`, that is a notification with no identifiable data, or with an encrypted payload. When the push is received the app can then synchronise to it's server in order to generate a local notification.
 
 
-## Background processing limitations
+### Background processing limitations
 
 A mobile applications process live in a managed word, meaning that its process can be limited (e.g no network access), stopped or killed at almost anytime by the Operating System.
 
@@ -167,15 +172,15 @@ The documentation on this subject is vague, and as per our experiments not alway
 
 It is getting more and more complex to have reliable notifications when FCM is not used.
 
-# Element Notification implementations
+## Element Notification implementations
 
-## Requirements
+### Requirements
 
 Element Android must work with and without FCM.
 * The Element android app published on F-Droid do not rely on FCM (all related dependencies are not present)
 * The Element android app published on google play rely on FCM, with a fallback mode when FCM registration has failed (e.g outdated or missing Google Play Services)
 
-## Foreground sync mode (Gplay & F-Droid)
+### Foreground sync mode (Gplay and F-Droid)
 
 When in foreground, Element performs sync continuously with a timeout value set to 10 seconds (see HttpPooling).
 
@@ -183,9 +188,9 @@ As this mode does not need to live beyond the scope of the application, and as p
 
 This mode is turned on when the app enters foreground, and off when enters background.
 
-In background, and depending on wether push is available or not, Element will use different methods to perform the syncs (Workers / Alarms / Service)
+In background, and depending on whether push is available or not, Element will use different methods to perform the syncs (Workers / Alarms / Service)
 
-## Push (FCM) received in background 
+### Push (FCM) received in background 
 
 In order to enable Push, Element must first get a push token from the firebase SDK, then register a pusher with this token on the homeserver.
 
@@ -225,10 +230,10 @@ Upon reception of the FCM push, Element will perform a sync call to the homeserv
 
 Element implements several strategies in these cases (TODO document)
 
-## FCM Fallback mode
+### FCM Fallback mode
 
 It is possible that Element is not able to get a FCM push token.
-Common errors (amoung several others) that can cause that:
+Common errors (among several others) that can cause that:
 * Google Play Services is outdated
 * Google Play Service fails in someways with FCM servers (infamous `SERVICE_NOT_AVAILABLE`)
 
@@ -246,7 +251,7 @@ Usually in this mode, what happen is when you take back your phone in your hand,
 
 The fallback mode is supposed to be a temporary state waiting for the user to fix issues for FCM, or for App Developers that has done a fork to correctly configure their FCM settings.
 
-## F-Droid background Mode
+### F-Droid background Mode
 
 The F-Droid Element flavor has no dependencies to FCM, therefore cannot relies on Push.
 
@@ -256,7 +261,7 @@ Only solution left is to use `AlarmManager`, that offers new API to allow launch
 
 Notice that these alarms, due to their potential impact on battery life, can still be restricted by the system. Documentation says that they will not be triggered more than every minutes under normal system operation, and when in low power mode about every 15 mn.
 
-These restrictions can be relaxed by requirering the app to be white listed from battery optimization.
+These restrictions can be relaxed by requiring the app to be white listed from battery optimization.
 
 F-Droid version will schedule alarms that will then trigger a Broadcast Receiver, that in turn will launch a Service (in the classic android way), and the reschedule an alarm for next time.
 
@@ -266,9 +271,7 @@ That is why on Element F-Droid, the broadcast receiver will acquire a temporary
 
 Note that foreground services require to put a notification informing the user that the app is doing something even if not launched).
 
-
-
-# Application Settings
+## Application Settings
 
 **Notifications > Enable notifications for this account**
 

docs/pull_request.md

@@ -1,5 +1,43 @@
 # Pull requests
 
+<!--- TOC -->
+
+* [Introduction](#introduction)
+* [Who should read this document?](#who-should-read-this-document?)
+* [Submitting PR](#submitting-pr)
+  * [Who can submit pull requests?](#who-can-submit-pull-requests?)
+    * [Humans](#humans)
+      * [Draft PR?](#draft-pr?)
+      * [Base branch](#base-branch)
+      * [PR Review Assignment](#pr-review-assignment)
+      * [PR review time](#pr-review-time)
+      * [Re-request PR review](#re-request-pr-review)
+      * [When create split PR?](#when-create-split-pr?)
+      * [Avoid fixing other unrelated issue in a big PR](#avoid-fixing-other-unrelated-issue-in-a-big-pr)
+    * [Bots](#bots)
+      * [Dependabot](#dependabot)
+      * [Gradle wrapper](#gradle-wrapper)
+      * [Sync analytics plan](#sync-analytics-plan)
+* [Reviewing PR](#reviewing-pr)
+  * [Who can review pull requests?](#who-can-review-pull-requests?)
+  * [What to have in mind when reviewing a PR](#what-to-have-in-mind-when-reviewing-a-pr)
+  * [Rules](#rules)
+    * [Check the form](#check-the-form)
+      * [PR title](#pr-title)
+      * [PR description](#pr-description)
+      * [File change](#file-change)
+      * [Check the commit](#check-the-commit)
+      * [Check the substance](#check-the-substance)
+      * [Make a dedicated meeting to review the PR](#make-a-dedicated-meeting-to-review-the-pr)
+  * [What happen to the issue(s)?](#what-happen-to-the-issues?)
+  * [Merge conflict](#merge-conflict)
+  * [When and who can merge PR](#when-and-who-can-merge-pr)
+    * [Merge type](#merge-type)
+  * [Resolve conversation](#resolve-conversation)
+* [Responsibility](#responsibility)
+
+<!--- END -->
+
 ## Introduction
 
 This document gives some clue about how to efficiently manage Pull Requests (PR). This document is a first draft and may be improved later.
@@ -116,7 +154,7 @@ Review such PR is the same recipe than for PR from Dependabot
 ##### Sync analytics plan
 
 This tools imports any update in the analytics plan. See instruction in the PR itself to handle it.
-More info can be found in the file [analytics.md]
+More info can be found in the file [analytics.md](./analytics.md)
 
 ## Reviewing PR
 
@@ -247,4 +285,4 @@ Also "Resolve conversation" should probably be hit by the creator of the convers
 
 PR submitter is responsible of the incoming change. PR reviewers who approved the PR take a part of responsibility on the code which will land to develop, and then be used by our users, and the user of our forks.
 
-That said, bug may still be merged on `develop`, this is still acceptable of course. In this case, please make sure an issue is created and correctly labelled. Ideally, such issues should be fixed before the next release candidate, i.e. with a higher priority. But as we release the application every 10 working days, it can be hard to fix every bugs. That's why PR should be fully tested and reviewed before being merge and we should never comment code review remark with "will be handled later", or similar comments.
+That said, bug may still be merged on `develop`, this is still acceptable of course. In this case, please make sure an issue is created and correctly labelled. Ideally, such issues should be fixed before the next release candidate, i.e. with a higher priority. But as we release the application every 10 working days, it can be hard to fix every bugs. That's why PR should be fully tested and reviewed before being merge and we should never comment code review remark with "will be handled later", or similar comments.

docs/signin.md

@@ -2,6 +2,27 @@
 
 This document describes the flow of signin to a homeserver, and also the flow when user want to reset his password. Examples come from the `matrix.org` homeserver.
 
+<!--- TOC -->
+
+* [Sign in flows](#sign-in-flows)
+  * [Get the flow](#get-the-flow)
+  * [Login with username](#login-with-username)
+    * [Incorrect password](#incorrect-password)
+    * [Correct password:](#correct-password:)
+  * [Login with email](#login-with-email)
+    * [Unknown email](#unknown-email)
+    * [Known email, wrong password](#known-email-wrong-password)
+      * [Known email, correct password](#known-email-correct-password)
+  * [Login with Msisdn](#login-with-msisdn)
+  * [Login with SSO](#login-with-sso)
+* [Reset password](#reset-password)
+  * [Send email](#send-email)
+    * [When the email is not known](#when-the-email-is-not-known)
+    * [When the email is known](#when-the-email-is-known)
+  * [User clicks on the link](#user-clicks-on-the-link)
+
+<!--- END -->
+
 ## Sign in flows
 
 ### Get the flow
@@ -322,4 +343,4 @@ curl -X POST --data $'{"auth":{"type":"m.login.email.identity","threepid_creds":
 {}
 ```
 
-The password has been changed, and all the existing token are invalidated. User can now login with the new password.
+The password has been changed, and all the existing token are invalidated. User can now login with the new password.

docs/signup.md

@@ -4,6 +4,20 @@ This document describes the flow of registration to a homeserver. Examples come
 
 *Ref*: https://matrix.org/docs/spec/client_server/latest#account-registration-and-management
 
+<!--- TOC -->
+
+* [Sign up flows](#sign-up-flows)
+  * [First step](#first-step)
+  * [Step 1: entering user name and password](#step-1:-entering-user-name-and-password)
+    * [If username already exists](#if-username-already-exists)
+  * [Step 2: entering email](#step-2:-entering-email)
+  * [Step 2 bis: user enters an email](#step-2-bis:-user-enters-an-email)
+  * [Step 3: Accepting T&C](#step-3:-accepting-t&c)
+  * [Step 4: Captcha](#step-4:-captcha)
+  * [Step 5: MSISDN](#step-5:-msisdn)
+
+<!--- END -->
+
 ## Sign up flows
 
 ### First step

docs/ui-tests.md

@@ -10,6 +10,20 @@ Currently the test are covering a small set of application flows:
 	- Self verification via emoji
 	- Self verification via passphrase
 
+<!--- TOC -->
+
+* [Prerequisites:](#prerequisites:)
+* [Run the tests](#run-the-tests)
+  * [From the source code](#from-the-source-code)
+  * [From command line](#from-command-line)
+* [Recipes](#recipes)
+  * [Wait for initial sync](#wait-for-initial-sync)
+  * [Accessing current activity](#accessing-current-activity)
+  * [Interact with other session](#interact-with-other-session)
+  * [Contributing to the UiAllScreensSanityTest](#contributing-to-the-uiallscreenssanitytest)
+
+<!--- END -->
+
 ## Prerequisites:
 
 Out of the box, the tests use one of the homeservers (located at http://localhost:8080) of the "Demo Federation of Homeservers" (https://github.com/matrix-org/synapse#running-a-demo-federation-of-synapses).

fastlane/metadata/android/cs-CZ/changelogs/40104120.txt

@@ -0,0 +1,2 @@
+Hlavní změny v této verzi: Umožňuje uživatelům zobrazovat se offline a přidává zvukový přehrávač pro zvukové přílohy
+Úplný seznam změn: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/cs-CZ/changelogs/40104130.txt

@@ -0,0 +1,2 @@
+Hlavní změny v této verzi: Umožňuje uživatelům zobrazovat se offline a přidává zvukový přehrávač pro zvukové přílohy
+Úplný seznam změn: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/cs-CZ/changelogs/40104140.txt

@@ -0,0 +1,2 @@
+Hlavní změny v této verzi: Zlepšení správy ignorovaných uživatelů. Opravy různých chyb a vylepšení stability.
+Úplný seznam změn: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/de-DE/changelogs/40104060.txt

@@ -0,0 +1,2 @@
+Hauptänderungen: Threads sind jetzt schneller, Fehlerbehebungen.
+Alle Änderungen: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/de-DE/changelogs/40104070.txt

@@ -0,0 +1,2 @@
+Änderungen: Fehlerbehebungen
+Alle Änderungen: https://github.com/vector-im/element-android/releases/tag/v1.4.7

fastlane/metadata/android/de-DE/changelogs/40104080.txt

@@ -0,0 +1,2 @@
+Hauptänderungen: Schnellere Threads, Fehlerbehebungen.
+Alle Änderungen: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/de-DE/changelogs/40104100.txt

@@ -0,0 +1,2 @@
+Hauptänderungen: Scrollen in Sprachnachrichten, Fehlerbehebungen.
+Alle Änderungen: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/de-DE/changelogs/40104110.txt

@@ -0,0 +1,2 @@
+Änderungen: Fehlerbehebungen und Stabilitätsverbesserungen
+Alle Änderungen: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/de-DE/changelogs/40104120.txt

@@ -0,0 +1,2 @@
+Hauptänderungen: Nutzer können ihren Status auf „Offline“ setzen, Gesendete Audiodateien können nun in der App abgespielt werden
+Alle Änderungen: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/de-DE/changelogs/40104130.txt

@@ -0,0 +1,2 @@
+Hauptänderungen: Nutzer können ihren Status auf „Offline“ setzen, Gesendete Audiodateien können nun in der App abgespielt werden
+Alle Änderungen: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/en-US/changelogs/40104160.txt

@@ -0,0 +1,2 @@
+Main changes in this version: Better management of encrypted messages. Various bug fixes and stability improvements.
+Full changelog: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/en-US/changelogs/40104180.txt

@@ -0,0 +1,2 @@
+Main changes in this version: Various bug fixes and stability improvements.
+Full changelog: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/es-ES/changelogs/40104140.txt

@@ -0,0 +1,2 @@
+Cambios principales en esta versión: Mejoras en la administración de usuarios ignorados. Varias correciones de bugs y mejoras en la estabilidad.
+Registro de cambios: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/et/changelogs/40104120.txt

@@ -0,0 +1,2 @@
+Põhilised muutused selles versioonis: kasutajate võrguolekud ning helisõnumite esitaja.
+Kogu ingliskeelne muudatuste logi: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/et/changelogs/40104130.txt

@@ -0,0 +1,2 @@
+Põhilised muutused selles versioonis: kasutajate võrguolekud ning helisõnumite esitaja.
+Kogu ingliskeelne muudatuste logi: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/et/changelogs/40104140.txt

@@ -0,0 +1,2 @@
+Põhilised muutused selles versioonis: eiratud kasutajate parem haldus ning erinevate vigade parandused ja stabiilsust edendavad kohendused.
+Kogu ingliskeelne muudatuste logi: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/fa/changelogs/40104120.txt

@@ -0,0 +1,2 @@
+تغییرات عمده در این نگارش: اجازه به کاربران برای برون‌خط ظاهر شدن و افزودن یک پخش‌کنندهٔ صدا برای پیوست‌های صوتی
+گزارش دگرگونی کامل: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/fa/changelogs/40104130.txt

@@ -0,0 +1,2 @@
+تغییرات عمده در این نگارش: اجازه به کاربران برای برون‌خط ظاهر شدن و افزودن یک پخش‌کنندهٔ صدا برای پیوست‌های صوتی
+گزارش دگرگونی کامل: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/fa/changelogs/40104140.txt

@@ -0,0 +1,2 @@
+تغییرات عمده در این نگارش: مدیریت بهبودیافتهٔ کاربران چشم‌پوشیده. رفع اشکال‌های مختلف و بهبودهای پایداری.
+گزارش دگرگونی کامل: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/fr-FR/changelogs/40104100.txt

@@ -0,0 +1,2 @@
+Principaux changements pour cette version : Défilement dans les messages vocaux. Plusieurs corrections de bogues et d’améliorations de stabilité.
+Intégralité des changements : https://github.com/vector-im/element-android/releases

fastlane/metadata/android/fr-FR/changelogs/40104110.txt

@@ -0,0 +1,2 @@
+Principaux changements pour cette version : Plusieurs corrections de bogues et d’améliorations de stabilité.
+Intégralité des changements : https://github.com/vector-im/element-android/releases

fastlane/metadata/android/fr-FR/changelogs/40104120.txt

@@ -0,0 +1,2 @@
+Principaux changements pour cette version : Les utilisateurs peuvent apparaître hors-ligne. Ajout d’un lecteur pour les pièces jointes audio
+Intégralité des changements : https://github.com/vector-im/element-android/releases

fastlane/metadata/android/fr-FR/changelogs/40104130.txt

@@ -0,0 +1,2 @@
+Principaux changements pour cette version : Les utilisateurs peuvent apparaître hors-ligne. Ajout d’un lecteur pour les pièces jointes audio
+Intégralité des changements : https://github.com/vector-im/element-android/releases

fastlane/metadata/android/fr-FR/changelogs/40104140.txt

@@ -0,0 +1,2 @@
+Principaux changements pour cette version : Amélioration de la gestion des utilisateurs ignorés. Plusieurs corrections de bogues et d’améliorations de stabilité.
+Intégralité des changements : https://github.com/vector-im/element-android/releases

fastlane/metadata/android/id/changelogs/40104120.txt

@@ -0,0 +1,2 @@
+Perubahan utama dalam versi ini: Diperbolehkan pengguna untuk terlihat luring dan ditambahkan sebuah pemain audio untuk lampiran audio
+Catatan perubahan lanjutan: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/id/changelogs/40104130.txt

@@ -0,0 +1,2 @@
+Perubahan utama dalam versi ini: Diperbolehkan pengguna untuk terlihat luring dan ditambahkan sebuah pemain audio untuk lampiran audio
+Catatan perubahan lanjutan: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/id/changelogs/40104140.txt

@@ -0,0 +1,2 @@
+Perubahan utama dalam versi ini: Tingkatkan pengelolaan pengguna yang diabaikan. Beberapa perbaikan kutu dan stabilitas.
+Catatan perubahan lanjutan: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/it-IT/changelogs/40104120.txt

@@ -0,0 +1,2 @@
+Modifiche principali in questa versione: consente agli utenti di apparire offline e aggiunge un player audio per gli allegati audio
+Cronologia completa: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/it-IT/changelogs/40104130.txt

@@ -0,0 +1,2 @@
+Modifiche principali in questa versione: consente agli utenti di apparire offline e aggiunge un player audio per gli allegati audio
+Cronologia completa: https://github.com/vector-im/element-android/releases

fastlane/metadata/android/it-IT/changelogs/40104140.txt

@@ -0,0 +1,2 @@
+Modifiche principali in questa versione: migliorata la gestione degli utenti ignorati. Varie correzioni e miglioramenti della stabilità.
+Cronologia completa: https://github.com/vector-im/element-android/releases