Architecture doc

[bmarty]

Type of change

• Feature
• Bugfix
• Technical
• Other : documentation

Content

Add a documentation to the project with the overall architecture and some entry points to other documentation and third party documentation.

rendered

As a bonus, add support to /devtools command.

Motivation and context

Help new comers to start working on the project.

Screenshots / GIFs

Tests

• try the new /devtools command

Tested devices

• Physical
• Emulator
• OS version(s):

Checklist

• Changes has been tested on an Android device or Android emulator with API 21
• UI change has been tested on both light and dark themes
• Accessibility has been taken into account. See https://github.com/vector-im/element-android/blob/develop/CONTRIBUTING.md#accessibility
• Pull request is based on the develop branch
• Pull request includes a new file under ./changelog.d. See https://github.com/vector-im/element-android/blob/develop/CONTRIBUTING.md#changelog
• Pull request includes screenshots or videos if containing UI changes
• Pull request includes a sign off
• You've made a self review of your PR
• If you have modified the screen flow, or added new screens to the application, you have updated the test UiAllScreensSanityTest.allScreensTest()

[ganfra]

Thats very helpful, thanks.
Just one small remark on the Event point!

[ganfra]

I'd more write:
There are 2 types of room Event:
State Events:....
Regular Events:...

You can also have event sent outside of a room, like AccountData

[bmarty]

OK, updated.

[sonarqubecloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

0.0% Coverage
0.0% Duplication

[ElementBot]

	Warnings
⚠️	vector/src/main/java/im/vector/app/features/home/room/detail/TimelineFragment.kt#L1127 - Prefer "SHOW_AS_ACTION_IF_ROOM" instead of "SHOW_AS_ACTION_ALWAYS"
⚠️	vector/src/main/java/im/vector/app/features/home/room/detail/TimelineFragment.kt#L1127 - Prefer "SHOW_AS_ACTION_IF_ROOM" instead of "SHOW_AS_ACTION_ALWAYS"

Generated by 🚫 dangerJS against 828413c