Update README for room list store

src/stores/room-list/README.md

@@ -7,20 +7,21 @@ It's so complicated it needs its own README.
 There's two main kinds of algorithms involved in the room list store: list ordering and tag sorting.
 Throughout the code an intentional decision has been made to call them the List Algorithm and Sorting
 Algorithm respectively. The list algorithm determines the behaviour of the room list whereas the sorting
-algorithm determines how individual tags (lists of rooms, sometimes called sublists) are ordered.
+algorithm determines how rooms get ordered within tags affected by the list algorithm.
 
-Behaviour of the room list takes the shape of default sorting on tags in most cases, though it can
+Behaviour of the room list takes the shape of determining what features the room list supports, as well
-override what is happening at the tag level depending on the algorithm used (as is the case with the
+as determining where and when to apply the sorting algorithm in a tag. The importance algorithm, which
-importance algorithm, described later).
+is described later in this doc, is an example of an algorithm which makes heavy behavioural changes
+to the room list.
 
 Tag sorting is effectively the comparator supplied to the list algorithm. This gives the list algorithm
 the power to decide when and how to apply the tag sorting, if at all.
 
 ### Tag sorting algorithm: Alphabetical
 
-When used, rooms in a given tag will be sorted alphabetically, where the alphabet is determined by a
+When used, rooms in a given tag will be sorted alphabetically, where the alphabet's order is a problem
-simple string comparison operation (essentially giving the browser the problem of figuring out if A
+for the browser. All we do is a simple string comparison and expect the browser to return something
-comes before Z).
+useful.
 
 ### Tag sorting algorithm: Manual
 
@@ -30,7 +31,7 @@ of `order` cause rooms to appear closer to the top of the list.
 
 ### Tag sorting algorithm: Recent
 
-Rooms are ordered by the timestamp of the most recent useful message. Usefulness is yet another algorithm
+Rooms get ordered by the timestamp of the most recent useful message. Usefulness is yet another algorithm
 in the room list system which determines whether an event type is capable of bubbling up in the room list.
 Normally events like room messages, stickers, and room security changes will be considered useful enough
 to cause a shift in time.
@@ -49,7 +50,7 @@ its relative deterministic behaviour.
 ### List ordering algorithm: Importance
 
 On the other end of the spectrum, this is the most complicated algorithm which exists. There's major
-behavioural changes and the tag sorting algorithm is selectively applied depending on circumstances.
+behavioural changes, and the tag sorting algorithm gets selectively applied depending on circumstances.
 
 Each tag which is not manually ordered gets split into 4 sections or "categories". Manually ordered tags
 simply get the manual sorting algorithm applied to them with no further involvement from the importance
@@ -58,34 +59,37 @@ relative (perceived) importance to the user:
 
 * **Red**: The room has unread mentions waiting for the user.
 * **Grey**: The room has unread notifications waiting for the user. Notifications are simply unread
-  messages which cause a push notification or badge count. Typically this is the default as rooms are
+  messages which cause a push notification or badge count. Typically, this is the default as rooms get
   set to 'All Messages'.
 * **Bold**: The room has unread messages waiting for the user. Essentially this is a grey room without
   a badge/notification count (or 'Mentions Only'/'Muted').
-* **Idle**: No relevant activity has occurred in the room since the user last read it.
+* **Idle**: No useful (see definition of useful above) activity has occurred in the room since the user 
+  last read it.
 
-Conveniently, each tag is ordered by those categories as presented: red rooms appear above grey, grey
+Conveniently, each tag gets ordered by those categories as presented: red rooms appear above grey, grey
-above idle, etc.
+above bold, etc.
 
 Once the algorithm has determined which rooms belong in which categories, the tag sorting algorithm
-is applied to each category in a sub-sub-list fashion. This should result in the red rooms (for example)
+gets applied to each category in a sub-sub-list fashion. This should result in the red rooms (for example)
-being sorted alphabetically amongst each other and the grey rooms sorted amongst each other, but 
+being sorted alphabetically amongst each other as well as the grey rooms sorted amongst each other, but 
 collectively the tag will be sorted into categories with red being at the top.
 
+<!-- TODO: Implement sticky rooms as described below -->
+
 The algorithm also has a concept of a 'sticky' room which is the room the user is currently viewing.
 The sticky room will remain in position on the room list regardless of other factors going on as typically
 clicking on a room will cause it to change categories into 'idle'. This is done by preserving N rooms
-above the selected room at all times where N is the number of rooms above the selected rooms when it was
+above the selected room at all times, where N is the number of rooms above the selected rooms when it was
 selected.
 
 For example, if the user has 3 red rooms and selects the middle room, they will always see exactly one
-room above their selection at all times. If they receive another notification and the tag ordering is set
+room above their selection at all times. If they receive another notification, and the tag ordering is 
-to Recent, they'll see the new notification go to the top position and the one that was previously there
+specified as Recent, they'll see the new notification go to the top position, and the one that was previously
-fall behind the sticky room.
+there fall behind the sticky room.
 
 The sticky room's category is technically 'idle' while being viewed and is explicitly pulled out of the
 tag sorting algorithm's input as it must maintain its position in the list. When the user moves to another
-room, the previous sticky room is recalculated to determine which category it needs to be in as the user
+room, the previous sticky room gets recalculated to determine which category it needs to be in as the user
 could have been scrolled up while new messages were received.
 
 Further, the sticky room is not aware of category boundaries and thus the user can see a shift in what 
@@ -112,7 +116,10 @@ all kinds of filtering.
 The `RoomListStore` is the major coordinator of various `Algorithm` implementations, which take care 
 of the various `ListAlgorithm` and `SortingAlgorithm` options. The `Algorithm` superclass is also 
 responsible for figuring out which tags get which rooms, as Matrix specifies them as a reverse map: 
-tags are defined on rooms and are not defined as a collection of rooms (unlike how they are presented 
+tags get defined on rooms and are not defined as a collection of rooms (unlike how they are presented 
 to the user). Various list-specific utilities are also included, though they are expected to move 
 somewhere more general when needed. For example, the `membership` utilities could easily be moved 
 elsewhere as needed.
+
+The various bits throughout the room list store should also have jsdoc of some kind to help describe
+what they do and how they work.