Commit graph

47 commits

Author SHA1 Message Date
Travis Ralston
bd1fd0a734 Step 13: Update documentation for skinning 2022-03-28 15:23:31 -06:00
Travis Ralston
d8a939df5d
Use & enforce snake_case naming convention on config.json settings (#8062)
* Document and support the established naming convention for config opts

This change:
* Rename `ConfigOptions` to `IConfigOptions` to match code convention/style, plus move it to a dedicated file
* Update comments and surrounding documentation
* Define every single documented option (from element-web's config.md)
* Enable a linter to enforce the convention
* Invent a translation layer for a different change to use
* No attempt to fix build errors from doing this (at this stage)

* Add demo of lint rule in action

* Fix all obvious instances of SdkConfig case conflicts

* Fix tests to use SdkConfig directly

* Add docs to make unset() calling safer

* Appease the linter

* Update documentation to match snake_case_config

* Fix more instances of square brackets off SdkConfig
2022-03-18 10:12:36 -06:00
Šimon Brandner
a58b1e9d79
Document keyboard shortcuts (#7908) 2022-03-04 12:14:52 +00:00
Kerry
e6ea58e84d
Load icons using @svgr (#7928)
* extend svg module

Signed-off-by: Kerry Archibald <kerrya@element.io>

* POC in QuickSettingsButton

Signed-off-by: Kerry Archibald <kerrya@element.io>

* stylelint

Signed-off-by: Kerry Archibald <kerrya@element.io>

* update copyright

Signed-off-by: Kerry Archibald <kerrya@element.io>

* remove aria-hidden, quick docs

Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-03-02 10:18:45 +01:00
David Teller
6b870ba1a9
MSC3531 - Implementing message hiding pending moderation (#7518)
Signed-off-by: David Teller <davidt@element.io>
2022-01-17 16:04:37 +01:00
Travis Ralston
af443c4cff
Update docs/room-list-store.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2021-04-02 19:33:16 -06:00
Travis Ralston
70db749430 Restabilize room list ordering with prefiltering on spaces/communities
Fixes https://github.com/vector-im/element-web/issues/16799

This change replaces the "relative priority" system for filters with a kind model. The kind is used to differentiate and optimize when/where a filter condition is applied, resulting in a more stable ordering of the room list. The included documentation describes what this means in detail.

This also introduces a way to inhibit updates being emitted from the Algorithm class given what we're doing to the poor thing will cause it to do a bunch of recalculation. Inhibiting the update and implicitly applying it (as part of our updateFn.mark()/trigger steps) results in much better performance.

This has been tested on my own account with both communities and spaces of varying complexity: it feels faster, though the measurements appear to be within an error tolerance of each other (read: there's no performance impact of this).
2021-03-31 23:36:36 -06:00
Germain Souquet
cfbcf12e1d docs: update file extensions in CIDER editor documentation 2021-03-22 15:02:28 +00:00
Travis Ralston
90817f3bc6 Developer documentation
The lint rules don't currently exist, but would apply to `mxcUrlToHttp` and `getHttpUriForMxc`
2021-03-11 09:19:59 -07:00
Travis Ralston
6985e8f41f Update documentation words 2021-01-19 10:00:45 -07:00
Travis Ralston
0359a977be
Update docs/widget-layouts.md
Co-authored-by: David Baker <dbkr@users.noreply.github.com>
2021-01-19 07:19:39 -07:00
Travis Ralston
39ce5d06e6 Describe how the widget layouts are supposed to look in time 2021-01-18 17:40:52 -07:00
Travis Ralston
f4f30a3274 Introduce a concept of UI features, using it for URL previews at first
Fixes https://github.com/vector-im/element-web/issues/15176

This is effectively the base for all of https://github.com/vector-im/element-web/issues/15185
2020-09-14 22:28:02 -06:00
Travis Ralston
0fef86cc74 Fix find & replace error 2020-08-19 11:52:02 -06:00
Travis Ralston
2c0e6c859a Update settings documentation for features 2020-08-17 13:32:33 -06:00
J. Ryan Stinnett
ce226ab534 Replace Riot with Element in docs and comments
This only covers the simple cases of references to issues and repos. More
complex areas, such as deployment scripts, will be handled separately.

Part of https://github.com/vector-im/element-web/issues/14864
2020-08-03 18:33:36 +01:00
Travis Ralston
3b346161a5 Actually include the docs for local echo 2020-07-30 09:24:38 -06:00
Travis Ralston
cc17409943
Fix words
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-06-12 08:37:08 -06:00
Travis Ralston
52b26deb2e Move room list store docs to docs directory
This pulls it away from the code, but the code is sufficiently involved enough where it doesn't need another file near it.
2020-06-11 16:56:12 -06:00
Bruno Windels
66aea5eea5 Merge branch 'develop' into bwindels/settings-config-doc 2020-04-01 11:43:03 +02:00
Bruno Windels
ce8f7eaace
Apply suggestions from code review
Co-Authored-By: Travis Ralston <travpc@gmail.com>
2020-04-01 09:37:17 +00:00
Bruno Windels
50bb556bc7
Update docs/settings.md
Co-Authored-By: Travis Ralston <travpc@gmail.com>
2020-04-01 09:36:50 +00:00
Travis Ralston
af97ec57d0
Apply suggestions from code review
Co-Authored-By: J. Ryan Stinnett <jryans@gmail.com>
2020-03-19 11:45:17 -06:00
Travis Ralston
9da57817d1 Use a local wrapper for Jitsi calls
Requires https://github.com/vector-im/riot-web/pull/12780
2020-03-18 15:50:12 -06:00
Bruno Windels
5d6690f74b document scrollpanel and bacat scrolling 2020-03-03 17:59:02 +01:00
Michael Telatynski
4ed27a4ba6 Move bulk to react-sdk and reference it from riot-web land
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-02-13 16:58:27 +00:00
Travis Ralston
9865ce899b Add a bunch of docs
We're making an assumption here that the decorator is actually all over the app when it's not.
2019-12-16 16:34:46 -07:00
Bruno Windels
8c02893da7
Update CIDER docs now that it is used for main composer as well 2019-11-21 08:58:13 +00:00
Bruno Windels
52dbcdb701 add readme explaining the purpose of this directory 2019-10-11 14:21:46 +02:00
Bruno Windels
a6892e7bac document the composer features 2019-10-11 14:19:00 +02:00
Bruno Windels
9e60e4b669
Update docs/settings.md
Co-Authored-By: Travis Ralston <travpc@gmail.com>
2019-10-02 09:00:24 +00:00
Bruno Windels
026733304e add doc for where default settings go in config file now we're here 2019-10-01 17:00:41 +02:00
Bruno Windels
36390da634 some doc improvements 2019-08-22 13:33:20 +01:00
Bruno Windels
dae6fae3d6 describe caret nodes 2019-08-02 13:45:52 +02:00
Bruno Windels
ad776fbfca describe all reasons why we need a custom textify algorithm 2019-08-02 13:45:35 +02:00
Bruno Windels
995ae41e67 add line breaks 2019-08-02 13:40:16 +02:00
Bruno Windels
30fd027adf document editor 2019-08-02 12:19:46 +02:00
Bruno Windels
9e4d8e7dfe document settingDefaults 2019-05-31 15:00:26 +02:00
J. Ryan Stinnett
147c287acd
Fix typo in Settings docs 2019-04-26 10:45:13 +01:00
Travis Ralston
fbffd3e97e Make the settings documentation fit within 120 characters per line 2019-02-26 12:52:59 -07:00
Travis Ralston
93673eff12 Use a global WatchManager for settings
Fixes https://github.com/vector-im/riot-web/issues/8936

Watchers are now managed by the SettingsStore itself through a global/default watch manager. As per the included documentation, the watch manager dispatches updates to callbacks which are redirected by the SettingsStore for consumer safety.
2019-02-26 12:52:59 -07:00
Travis Ralston
7ea4008daa Implement support for watching for changes in settings
This implements a dream of one day being able to listen for changes in a settings to react to them, regardless of which device actually changed the setting. The use case for this kind of thing is extremely limited, but when it is needed it should be more than powerful enough.
2019-02-22 17:09:07 -07:00
Travis Ralston
7515a3124a
Explain feature states in a lot more detail 2018-10-11 10:22:28 -06:00
Matthew Hodgson
d7ff7cd4ed stupid thinkotypo 2018-07-16 12:00:15 +01:00
Matthew Hodgson
83f2614919
add guide to slate's data formats and how we convert
(cherry picked from commit e7e4ee8)
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2018-07-09 19:54:10 +01:00
Travis Ralston
f0000f7400 Update documentation
Signed-off-by: Travis Ralston <travpc@gmail.com>
2017-11-05 14:33:40 -07:00
Travis Ralston
6f8523081b Some documentation
Far from complete, and probably needs a bit of work, but it's a start.

Signed-off-by: Travis Ralston <travpc@gmail.com>
2017-10-30 21:09:24 -06:00