Commit Graph

519 Commits

Author SHA1 Message Date
J. Ryan Stinnett
bf5a69d3a0 Document the mobile guide toast option
Part of https://github.com/vector-im/element-web/issues/16283
2021-01-28 17:28:52 +00:00
David Baker
342d0474fd
Merge pull request #16236 from vector-im/dbkr/voip_user_mapper
Docs for the VoIP translate pattern option
2021-01-22 14:11:54 +00:00
David Baker
f8b9958010 Docs for the voip translate pattern option 2021-01-21 19:23:57 +00:00
Travis Ralston
40f2ba8205
Fix Riot->Element in permalinkPrefix docs 2021-01-20 14:39:01 -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
J. Ryan Stinnett
d8408933f1 Upgrade warning severity 2020-12-10 14:29:38 +00:00
J. Ryan Stinnett
ec781b3ebe Document pull request previews
This documents the pull request previews we recently added when working on
https://github.com/vector-im/element-web/issues/12624.
2020-12-09 13:59:45 +00:00
J. Ryan Stinnett
301ea6a5f3
Merge pull request #15277 from akissinger/katex
added katex.min.css to webpack for math support (main PR in matrix-react-sdk)
2020-11-27 11:55:56 +00:00
Aleks Kissinger
e743a12f30 matched setting name to PR in matrix-react-sdk 2020-11-26 17:40:14 +00:00
J. Ryan Stinnett
f1e89bf833 Replace various instances of Riot with Element 2020-11-25 17:01:19 +00:00
Travis Ralston
71206e8e3d Add documentation for new UIFeature flag regarding room history settings 2020-10-27 19:23:06 -06:00
J. Ryan Stinnett
4d2e4d30ca Update translation project names 2020-10-21 13:23:38 +01:00
J. Ryan Stinnett
6420120dd4 Update Weblate URL 2020-10-21 13:16:43 +01:00
J. Ryan Stinnett
f37b63a6cb
Fix file extension
Co-authored-by: Travis Ralston <travpc@gmail.com>
2020-10-16 11:22:28 +01:00
J. Ryan Stinnett
7793f07c81 Document customisation points
https://github.com/matrix-org/matrix-react-sdk/pull/5327 adds a concept of
"customisation points" to keep custom functionality contained. This adds some
general guidance on how to use them.
2020-10-15 18:01:38 +01:00
Aleks Kissinger
89ce904ebb Merge branch 'develop' into katex 2020-10-10 19:32:35 +01:00
Aleks Kissinger
1dae7df28a added doc for latex_maths feature flag 2020-10-10 19:01:30 +01:00
Hubert Chathi
49fd9f827d document dehydration feature flag 2020-10-06 15:29:45 -04:00
J. Ryan Stinnett
4753a49819
Merge pull request #15325 from resynth1943/patch-3
Update Riot -> Element in docs/feature-flags.md
2020-09-30 13:41:02 +01:00
Qt Resynth
db08128954
Riot -> Element 2020-09-30 12:04:01 +00:00
Qt Resynth
48f71f26e7
Apply suggestions from code review
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-09-30 11:58:44 +00:00
Qt Resynth
21329f17c9
Update Riot -> Element in docs/review.md 2020-09-30 11:05:19 +00:00
Qt Resynth
407777539f
Moar Element 'n' Stuff
Gotta fix that up :-) 
Man this is how I spend my free time
2020-09-30 11:00:02 +00:00
J. Ryan Stinnett
307f7c23e9 Document config for preferring Secure Backup setup methods
Part of https://github.com/vector-im/element-web/issues/15238
2020-09-21 15:56:38 +01:00
Travis Ralston
c364215d53 Add missing options 2020-09-18 12:24:06 -06:00
Travis Ralston
72d1950bea Update documentation for UI Features 2020-09-17 22:22:11 -06:00
Travis Ralston
85979079f1 Add end-user documentation for UI features 2020-09-14 22:28:57 -06: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
J. Ryan Stinnett
bc1cad01c4 Add testing to review guidelines
This adds a initial statement on testing to the review guidelines. No
requirements are made at this time, but reviewers are encouraged to request
tests where they believe it is reasonable to provide them.

Fixes https://github.com/vector-im/element-web/issues/14945
2020-08-26 15:57:31 +01:00
J. Ryan Stinnett
a3b8c67e79
Merge pull request #15003 from vector-im/jryans/secure-backup-required
Document .well-known E2EE secure backup setting
2020-08-24 17:33:05 +01:00
J. Ryan Stinnett
3800fe0c9b Use io.element instead of im.vector
This also fixes casing as well to match the latest thinking.
2020-08-24 16:34:58 +01:00
Travis Ralston
b4173f3e08 Add docs for labs flag 2020-08-20 19:46:19 -06:00
Travis Ralston
5f03004664
Merge pull request #14986 from vector-im/travis/settings-v3
Settings v3: Update documentation and configs for new feature flag behaviour
2020-08-19 11:57:00 -06:00
Travis Ralston
0fef86cc74 Fix find & replace error 2020-08-19 11:52:02 -06:00
J. Ryan Stinnett
7435175a76
Merge pull request #14952 from vector-im/Custom_jitsi_android
Update jitsi.md
2020-08-19 18:19:17 +01:00
J. Ryan Stinnett
8cfb0a71a0
Apply suggestions from code review 2020-08-19 18:18:50 +01:00
J. Ryan Stinnett
fa265e498f Document new setting to require secure backup
This adds notes on configuring the new `.well-known` setting to require Element
users to set up secure backup before continuing into the app.

Part of https://github.com/vector-im/element-web/issues/14954
2020-08-19 16:22:56 +01:00
J. Ryan Stinnett
8b0eafe50f Document new .well-known for E2EE settings
This updates documentation about the new key in `.well-known` that we'll check
for E2EE settings: `im.vector.e2ee`.

Part of https://github.com/vector-im/element-web/issues/14954
2020-08-19 16:22:56 +01:00
Travis Ralston
2c952b422b Update config.md for new feature behaviour 2020-08-17 14:02:19 -06:00
Travis Ralston
3e924941c3 Update feature flags documentation for new feature behaviour 2020-08-17 14:00:04 -06:00
Travis Ralston
2c0e6c859a Update settings documentation for features 2020-08-17 13:32:33 -06:00
Michael Telatynski
305570d8e3 Document new labs tweaks 2020-08-14 10:56:30 +01:00
Valere
993fd04353
Update jitsi.md
Updated Element Android section
2020-08-13 19:09:36 +02: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
Michael (a.k.a. Resynth)
de6d72fe3e
Fix typo in https://
See [this comment[(https://github.com/vector-im/riot-web/pull/14581#discussion_r461553693).
2020-07-28 13:59:01 +00:00
J. Ryan Stinnett
37b75eaf31
Merge branch 'develop' into resynth1943-patch-riot-to-element 2020-07-21 10:20:02 +01:00
Resynth
622ea3ead6
Update labs.md 2020-07-18 11:07:59 +00:00
Resynth
7598942800
Update labs.md 2020-07-18 11:07:33 +00:00
Travis Ralston
ef16ef4272 Remove labs info for the new room list 2020-07-17 16:27:03 -06:00
Resynth
b1cf1a2d1a Update docs/translating.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-07-17 13:04:55 +01:00
Resynth
a8a6c538fa Update docs/skinning thoughts.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-07-17 13:04:55 +01:00
Resynth
9be8c1c8b0 Update docs/skinning thoughts.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-07-17 13:04:55 +01:00
Resynth
6b317798dc Update docs/review.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-07-17 13:04:55 +01:00
resynth1943
9fa8b7a9b3 Update docs/labs.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-07-17 13:04:44 +01:00
Resynth
dde3f93822 Update translating.md 2020-07-17 13:04:03 +01:00
Resynth
ffd802f726 Update translating-dev.md 2020-07-17 13:04:03 +01:00
Resynth
55ea61b36c Update theming.md 2020-07-17 13:04:03 +01:00
Resynth
44c15df58e Update skinning thoughts.md 2020-07-17 13:04:03 +01:00
Resynth
17649dc2b1 Update review.md 2020-07-17 13:04:03 +01:00
Resynth
5d8b246ef1 Update native-node-modules.md 2020-07-17 13:04:03 +01:00
Resynth
0f159c5d77 Update memory-profiles-and-leaks.md 2020-07-17 13:04:03 +01:00
Resynth
f2b9bd4c49 Update labs.md 2020-07-17 13:04:03 +01:00
Resynth
bbd1974eb4 Update jitsi-dev.md 2020-07-17 13:04:03 +01:00
Resynth
6f04841e4b Update e2ee.md 2020-07-17 13:04:03 +01:00
Resynth
7c4cef614e Update config.md 2020-07-17 13:04:03 +01:00
Resynth
f8ed536bb8 Update jitsi.md 2020-07-17 13:04:03 +01:00
Resynth
9687575c86 Change Riot → Element in docs/feature-flags.md 2020-07-17 13:04:03 +01:00
Jorik Schellekens
f5209c0d7e Merge branch 'develop' of github.com:vector-im/riot-web into joriks/delabs-font-scaling 2020-07-14 21:51:41 +01:00
Travis Ralston
e6706b0e7b Merge branch 'develop' into travis/room-list/enable 2020-07-10 21:34:42 -06:00
Travis Ralston
28b5b0b552 Update labs.md for new room list 2020-07-07 14:00:52 -06:00
Jorik Schellekens
817759f590 Remove font scaling from labs 2020-07-06 15:45:30 +01:00
Jorik Schellekens
e95036405b Release the irc layout to the wild 2020-07-06 15:22:57 +01:00
Andrew Morgan
993155d56a Add the new spinner feature 2020-06-26 11:02:55 +01:00
Bruno Windels
fe0ed2b4f3
Update docs/theming.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-06-24 13:15:59 +00:00
Bruno Windels
2ce448943b add documentation for fonts in custom theme 2020-06-24 14:55:57 +02:00
Travis Ralston
cbf35a6060 Mark the new room list as ready for general testing 2020-06-18 15:46:04 -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
Michael Telatynski
bce0bf1b1d
Apply suggestions from code review
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-06-04 12:38:45 +01:00
Michael Telatynski
faca8799db Add e2ee-default:false docs
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-06-03 22:10:48 +01:00
Arthur Lutz
d0413f0d15
[docs/config.md] typo fix 2020-06-03 14:59:34 +02:00
Michael Telatynski
c29dc0bad8 Remove cross-signing from labs
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-06-03 10:44:42 +01:00
Michael Telatynski
af8fb33b83 add line
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-05-28 14:28:14 +01:00
Michael Telatynski
361cc4ab5c Add app-load doc
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-05-28 14:26:51 +01:00
Travis Ralston
6f7570d877
Merge branch 'develop' into travis/room-list-2 2020-05-21 13:29:20 -06:00
Travis Ralston
03414d92d0
Merge pull request #13352 from vector-im/revert-13351-revert-13199-joriks/font-sclaing-slider
Add font scaling labs setting.
2020-05-20 10:05:28 -06:00
Travis Ralston
aae5e4c234
Merge pull request #13350 from JorikSchellekens/joriks/font-sclaing-slider
Add labs flag for alternate message layouts
2020-05-19 14:53:01 -06:00
Jorik Schellekens
3a7578b7ee Remove avatar flag 2020-05-19 18:30:30 +01:00
Travis Ralston
81010a4f2f Add docs for room list labs flag 2020-05-14 14:24:34 -06:00
Jorik Schellekens
585cfbbaf9 Update docs 2020-05-07 16:18:11 +01:00
Michael Telatynski
f4e21c3fc7 Remove electron_app as we now have riot-desktop repo
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-05-06 11:32:13 +01:00
Jorik Schellekens
6d19d1b346 Change setting location. 2020-04-28 16:56:23 +01:00
Bruno Windels
5c77b0371a add line break 2020-04-28 11:07:16 +02:00
Bruno Windels
1c413a4f81 clarify how to use in CSS 2020-04-27 20:17:13 +02:00
Bruno Windels
f55c5aedc1 update docs with custom theming changes 2020-04-27 19:44:05 +02:00
Travis Ralston
215ad07493 Remove docs and config for invite only padlocks
See https://github.com/matrix-org/matrix-react-sdk/pull/4487
2020-04-24 10:03:14 -06:00
Travis Ralston
58bf82186c
Revert "Revert "Add font scaling labs setting."" 2020-04-23 13:17:20 -06:00
Travis Ralston
2c62d47e6c
Revert "Add font scaling labs setting." 2020-04-23 13:16:49 -06:00
Jorik Schellekens
4f7081fc2b Add labs flag for alternate message layouts 2020-04-23 19:12:10 +01:00
J. Ryan Stinnett
fa223b94bc
Merge pull request #13341 from vector-im/jryans/feature-flags-releases
Expand feature flag docs to cover additional release channels
2020-04-23 15:33:51 +01:00
J. Ryan Stinnett
527d18ac42 riot-desktop now has a develop branch 2020-04-23 15:20:42 +01:00
J. Ryan Stinnett
2774b046b3 Expand feature flag docs to cover additional release channels
This adds further detail around the various additional release channels we have
for desktop. It also expands on the current state of enabling a feature by
default.
2020-04-23 11:06:15 +01:00
Jorik Schellekens
6873b48c42
Merge pull request #13199 from JorikSchellekens/joriks/font-sclaing-slider
Add font scaling labs setting.
2020-04-23 10:30:40 +01:00
Jorik Schellekens
3e21483b82 Try to silence the e2e test
Merge branch 'develop' of github.com:vector-im/riot-web into joriks/font-sclaing-slider
2020-04-23 10:19:45 +01:00
Travis Ralston
c23b2415e4 Remove encrypted message search feature flag
See https://github.com/matrix-org/matrix-react-sdk/pull/4467
2020-04-22 10:59:47 -06:00
Travis Ralston
6b1965388e
Merge pull request #13312 from vector-im/travis/docs-settings-fix
Fix `default_federate` settting description
2020-04-22 08:36:17 -06:00
Travis Ralston
601816862f
Clarify that the .well-known method for Jitsi isn't available yet
We should remove this at release time, but if we forget it should be vaguely worded well enough.

People keep assuming it'll just work even though the feature hasn't launched yet. The original theory was that a release was around the corner, but it's since been pushed back several times.
2020-04-21 13:27:05 -06:00
Travis Ralston
25dbeca083
Fix default_federate settting description 2020-04-21 09:27:03 -06:00
Jorik Schellekens
7d74e789ca Fix slight innacuracy. 2020-04-21 15:18:22 +01:00
Jorik Schellekens
abcf0b73c0 Docs on font-scaling 2020-04-21 10:05:05 +01:00
Michael Kohler
752b6b63ec Document more config options in config.md (fixes #13089)
Signed-off-by: Michael Kohler <me@michaelkohler.info>
2020-04-19 11:44:58 +02:00
The Stranjer
3a551f2da5 Allow admins to create an array of backgrounds to be randomly chosen from 2020-04-17 06:31:49 -04:00
Travis Ralston
bea0dab623 Update cross-signing feature docs and document fallback procedures
For https://github.com/matrix-org/matrix-react-sdk/pull/4416
2020-04-16 11:35:28 -06:00
Sean Cross
e536b07874 docs: labs: add a pointer to config.md
The documentation mentions that Labs features can be manipulated by
opening the Settings menu and selecting Labs.  This feature is normally
disabled, so for most users this is not the case.

Add a link to the `config.md` file and a note that the Labs features
must be enabled in order to manipulate them.

Signed-off-by: Sean Cross <sean@xobs.io>
2020-04-13 13:48:10 +08:00
Travis Ralston
83088961d0 Mention Jitsi support at the .well-known level in Jitsi docs
For https://github.com/matrix-org/matrix-react-sdk/pull/4348
2020-04-06 16:12:36 -06:00
Travis Ralston
99f8019aa2 Update docs per suggestions 2020-04-06 14:50:06 -06:00
Travis Ralston
abf475ee80 Add some docs about Jitsi widgets and Jitsi configuration 2020-04-03 13:25:33 -06:00
Bruno Windels
66aea5eea5 Merge branch 'develop' into bwindels/settings-config-doc 2020-04-01 11:43:03 +02:00
David Baker
421fcb115f Give the jitsi wrapper its own external api script 2020-04-01 10:38:49 +01: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
Jorik Schellekens
6ed81eadbf Some grammar and clarifications. 2020-03-30 11:52:23 +01:00
J. Ryan Stinnett
da249cbc40 Merge remote-tracking branch 'origin/develop' into jryans/review-policy 2020-03-26 11:34:29 +00:00
J. Ryan Stinnett
5b94d8bbd7 Add line about UI for network activity 2020-03-26 11:28:51 +00:00
Travis Ralston
775e1fc4ae
Merge pull request #12780 from vector-im/travis/wrapped-jitsi
Use a local widget wrapper for Jitsi calls
2020-03-19 11:52:22 -06: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
Michael Telatynski
9055d0b8b5
Delete shortcuts.md
The in-app keyboard shortcuts view has more.
https://github.com/matrix-org/matrix-react-sdk/pull/4231
2020-03-19 10:52:48 +00: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
Travis Ralston
e1eb16ce46 Use a local widget wrapper for Jitsi calls
Effectively fixes https://github.com/vector-im/riot-web/issues/11074
Effectively fixes https://github.com/vector-im/riot-web/issues/7112
Fixes https://github.com/vector-im/riot-web/issues/6930
Fixes Jitsi widgets not working for guests (https://github.com/vector-im/riot-web/issues/8933)
Fixes https://github.com/vector-im/riot-web/issues/5048

Previously we were relying on an integration manager to be defined, functional, and alive in order to join Jitsi calls. This commit changes this so we aren't reliant on an integration manager for Jitsi calls at all, and gives people the option of choosing a Jitsi server via the config.json.

This side is just the wrapper/shell: the logic is mostly in the react-sdk (to be linked via PRs). This layer simply has an HTML file exported that can be used to render a Jitsi widget, and the react-sdk constructs a URL to access it locally. This is similar to how the mobile apps handle Jitsi widgets: instead of iframing the widget URL directly into the app, they pull apart the widget information and natively render it. We're effectively doing the same here by parsing the widget options and using our local wrapper instead of whatever happens to be defined in the widget state event.

Integration managers should still continue to offer a widget URL for Jitsi widgets as this is what the spec requires.

A large part of this is based upon Dimension's handling of Jitsi and widgets in general: a license has been granted to allow Riot (and therefore the react-sdk) to use the code and be inspired by it.
2020-03-18 15:48:02 -06:00
J. Ryan Stinnett
5808ea2ba1 Add notes about chatting with the team 2020-03-18 11:18:29 +00:00
J. Ryan Stinnett
e348546e59 Reformat 2020-03-18 10:59:46 +00:00
J. Ryan Stinnett
34f3671c09 Add notes on review request handling 2020-03-18 10:59:33 +00:00
J. Ryan Stinnett
3989f41985 Clarify merge options 2020-03-18 10:53:48 +00:00
J. Ryan Stinnett
bd8b3a9046 Move multi-repo linking to workflow section 2020-03-18 10:21:28 +00:00
J. Ryan Stinnett
1aecc3d7e5
Add multi-repo PR linking
Co-Authored-By: Travis Ralston <travpc@gmail.com>
2020-03-18 10:18:41 +00:00
J. Ryan Stinnett
0b772ca50a
Tweak issue assigning
Co-Authored-By: Travis Ralston <travpc@gmail.com>
2020-03-13 16:48:03 +00:00
J. Ryan Stinnett
d930d14735 Add review policy doc
This documents various attributes of our overall review policy from code,
design, and product perspectives.

Fixes https://github.com/vector-im/riot-web/issues/12614
2020-03-13 16:39:29 +00:00
Travis Ralston
98bd951366 Add docs and flag for custom theme support 2020-03-13 09:34:16 -06:00
Bruno Windels
5d6690f74b document scrollpanel and bacat scrolling 2020-03-03 17:59:02 +01:00
J. Ryan Stinnett
9fb807772b Document start / end composer shortcuts
This documents shortcuts for jumping to the start / end of the composer
contents.

Part of https://github.com/vector-im/riot-web/issues/12438
Depends on https://github.com/matrix-org/matrix-react-sdk/pull/4108
2020-02-21 19:00:47 +00: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
Michael Telatynski
2645e6f525 Merge branches 'develop' and 't3chguy/usercontent' of github.com:vector-im/riot-web into t3chguy/usercontent 2020-02-13 16:36:11 +00:00
Matthew Thomas
a24959319d
Add top left menu shortcut
Add <kbd>Ctrl</kbd>/<kbd>⌘</kbd>+<kbd>`</kbd>
2020-02-10 12:59:35 -06:00
Michael Telatynski
98773df76e Get rid of dependence on usercontent.riot.im 2020-02-07 22:07:30 +00:00
Matthew Hodgson
c3e6a30789 Merge branch 'develop' of git+ssh://github.com/vector-im/riot-web into develop 2020-01-31 15:22:44 +00:00
Matthew Hodgson
87913e6c98 yarn electron nowadays does yarn build already 2020-01-31 15:22:16 +00:00
J. Ryan Stinnett
e9f8700d6b Document padlock flag 2020-01-31 13:36:16 +00:00
Matthew Hodgson
d8b059452c fix rogue ` 2020-01-31 13:04:00 +00:00
Travis Ralston
8b08ba05c2 Remove docs for new invite dialog labs feature
It's the default now: https://github.com/matrix-org/matrix-react-sdk/pull/3906
2020-01-22 21:16:18 -07:00
J. Ryan Stinnett
fe15d3b7c1 Add docs for admin report content message
Part of https://github.com/vector-im/riot-web/issues/11992
2020-01-22 14:18:29 +00:00
Travis Ralston
276d14dd5d Update labs documentation for feature_ftue_dms given new scope
See https://github.com/matrix-org/matrix-react-sdk/pull/3854
2020-01-16 14:46:19 -07:00
J. Ryan Stinnett
12267159f2 Enable and document presence in room list feature flag
Part of https://github.com/vector-im/riot-web/issues/11799
2020-01-13 11:53:46 +00:00
Will Hunt
50fe3109c0
Add feature_bridge_state 2020-01-05 15:47:14 +00:00
Travis Ralston
16e384172c Add docs for feature_ftue_dms flag
This should hopefully be short-lived.

For https://github.com/matrix-org/matrix-react-sdk/pull/3792
2020-01-02 17:44:58 -07: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
Matthew Hodgson
f8c2529d44 doc how i had to build seshat 2019-11-27 02:22:41 +00:00
Damir Jelić
222fea969d Merge branch 'poljar/seshat-pr' into develop 2019-11-26 18:47:58 +01:00
Damir Jelić
e5956de744 labs: Clarify that the event indexing feature supports E2EE search. 2019-11-26 18:39:22 +01:00
Damir Jelić
f28f27a87b labs: Document the event indexing labs feature. 2019-11-26 18:03:46 +01:00
Damir Jelić
b0783a8995 native-node-modules: Mention that Seshat requires SQLCipher. 2019-11-26 18:02:49 +01:00
Damir Jelić
1869350a9b native-node-modules: Remove a spurious and. 2019-11-26 10:38:49 +01:00
Damir Jelić
5b8e918d6e native-node-modules: Explain how to install Rust and link to its docs. 2019-11-26 10:21:15 +01:00
Damir Jelić
f0fe968944 native-node-modules: Capitalize some project names. 2019-11-26 10:20:56 +01:00
Damir Jelić
40f2648fd3 native-node-modules: Expand the Seshat subtitle a bit. 2019-11-26 10:19:45 +01:00
Damir Jelić
b1aff2995d native-node-modules: Explain the packaging situation a bit. 2019-11-26 10:19:15 +01:00
Damir Jelić
5f6636e28b native-node-modules: Reword the second paragraph. 2019-11-26 10:13:38 +01:00
Damir Jelić
b52141d6a8 native-node-modules: Add a section about cross compilation. 2019-11-26 10:12:52 +01:00
Damir Jelić
da4b4037a8 native-node-modules: Don't mention the riot version that supports native modules. 2019-11-26 10:03:45 +01:00
Damir Jelić
4c629e82c8 native-node-modules: Add a header level to the title. 2019-11-26 10:00:15 +01:00
J. Ryan Stinnett
84df4785f8 Remove timeframe 2019-11-25 16:25:19 +00:00
J. Ryan Stinnett
7b8ab047ed Clarify that cross-signing is in development
Expand on the development state of cross-signing in the labs docs.

Fixes https://github.com/vector-im/riot-web/issues/11492
2019-11-25 14:29:28 +00:00
Damir Jelić
d0b53916e3 docs: Add documentation explaining how to enable Seshat support. 2019-11-21 10:56:25 +01: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
David Baker
9ed4a07b28 linewrap 2019-11-20 17:39:58 +00:00
Bruno Windels
21781adb9e explain the internal name of custom themes 2019-11-20 18:27:25 +01:00
David Baker
dc3cc37784 backticks to prevent infinitalic 2019-11-20 16:35:10 +00:00
David Baker
013e059ffc Add doc for custom themes
Mostly just c+ped from Bruno's PR: https://github.com/matrix-org/matrix-react-sdk/pull/3503
2019-11-20 15:40:44 +00:00
Bruno Windels
c197f7996b merge the feature_user_info_panel flag into feature_dm_verification 2019-11-19 14:15:11 +01:00
J. Ryan Stinnett
8043aebe1a Add cross-signing labs flag to develop and document
Part of https://github.com/vector-im/riot-web/issues/11407
2019-11-18 16:06:32 +00:00
Bruno Windels
5041e6f3d9
Merge branch 'develop' into travis/mjolnir 2019-11-11 15:47:29 +00:00
Bruno Windels
d3778ab1fd
Add description of user info feature 2019-11-11 13:59:32 +00:00
Travis Ralston
4eb0f014b8
Add DM verification feature to labs.md 2019-11-08 14:54:24 -07:00
J. Ryan Stinnett
d373e2891e Describe regular setting path 2019-11-08 15:57:46 +00:00
J. Ryan Stinnett
8b0257d24b Apply suggestions from code review
Co-Authored-By: Travis Ralston <travpc@gmail.com>
2019-11-08 15:57:09 +00:00
J. Ryan Stinnett
fa3d3aa4dd Absolute URLs 2019-11-08 15:55:01 +00:00
J. Ryan Stinnett
9ca438087e Add numbers 2019-11-08 15:55:01 +00:00
J. Ryan Stinnett
037d8c071c Document feature flag process
This records the feature flag process we intend to use with Riot and also how
that interacts with other teams and configuration.

Fixes https://github.com/vector-im/riot-web/issues/11116
2019-11-08 15:55:01 +00:00
Travis Ralston
956c199fcf Add some docs to describe Mjolnir and Ban Lists 2019-11-06 12:25:34 -07:00
Travis Ralston
1b4f4b6b65 Add labs documentation for Mjolnir 2019-10-31 13:21:15 -06:00
J. Ryan Stinnett
19e183c801
Add missing word
Co-Authored-By: Travis Ralston <travpc@gmail.com>
2019-10-28 19:56:38 +02:00
J. Ryan Stinnett
5117c04883 Update config docs about identity servers
This updates the discussion of identity servers in the config docs to match what
was shipped in the privacy sprint.

Fixes https://github.com/vector-im/riot-web/issues/10982
2019-10-28 16:57:22 +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
Travis Ralston
98b4681dc5 Remove docs for CIDER feature
See https://github.com/matrix-org/matrix-react-sdk/pull/3519
2019-10-03 23:21:52 -06:00
Travis Ralston
509ed81294 Document troubleshooting for memory leaks and getting profiles
People find this useful.
2019-10-02 09:06:13 -06:00
Bruno Windels
c0a0466b6c
Merge pull request #11017 from vector-im/bwindels/custom-themes-mvp
Custom themes MVP
2019-10-02 09:14:18 +00: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
31dc423d1d line wrap 2019-10-02 09:04:36 +02:00
Bruno Windels
beaf6b0e0d document settingsDefault now I'm using it and had to look it up again 2019-10-01 17:01:45 +02: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
Travis Ralston
1aa48be01e Document permalinkPrefix setting
There's no sample config changes because we don't want to encourage people using this setting. It is for very limited scenarios only: unfederated servers.
2019-09-30 13:05:44 -06:00
Paul Tötterman
481bc2cb92
Update docs/shortcuts.md
Co-Authored-By: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2019-09-18 13:32:24 +03:00
Paul Tötterman
2eddda1843
Update docs/shortcuts.md
Co-Authored-By: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2019-09-18 13:21:23 +03:00
Paul Tötterman
55c809e839
Document more shortcuts
I'm probably missing some still
2019-09-18 11:55:44 +03:00
Bruno Windels
b809343cb6 line wrap 2019-09-12 17:04:24 +02:00
Bruno Windels
d6e0f33fdb
document disable_custom_urls 2019-09-12 12:34:48 +00:00
Travis Ralston
7bf1680ff8 Add docs for tabbed integration managers labs flag 2019-08-23 08:47:21 -06:00
Travis Ralston
3f70c0d66d Add docs for the CIDER composer flag 2019-08-23 08:28:47 -06: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
Travis Ralston
83da5e6004 Update references to features 2019-07-25 14:53:53 -06:00
Travis Ralston
ec9309edcd Update feature references 2019-07-25 14:52:20 -06:00
J. Ryan Stinnett
8398ec5358 Remove reactions feature flag from docs and config
Part of https://github.com/vector-im/riot-web/issues/10282
2019-07-18 10:48:43 +01:00
J. Ryan Stinnett
7731f93676 Remove edits feature flag from docs and config
Part of https://github.com/vector-im/riot-web/issues/10282
2019-07-18 10:46:19 +01:00
Travis Ralston
f3e82b56e9 Remove unused disable_identity_server config flag
Fixes https://github.com/vector-im/riot-web/issues/10229
2019-07-11 15:11:59 -06:00
J. Ryan Stinnett
73d801cb1d Extract configuration docs to separate file
The main README is very busy with too much information in one file. This
attempts to clean up one portion by moving configuration docs to a separate
file.

Fixes https://github.com/vector-im/riot-web/issues/9965
2019-06-27 19:08:33 +01:00
Bruno Windels
9e4d8e7dfe document settingDefaults 2019-05-31 15:00:26 +02:00
Bruno Windels
f5e7dd5164 add description of new labs feature for message editing 2019-05-15 10:02:50 +01:00
J. Ryan Stinnett
bb675fde0c Tweak redundant title 2019-05-01 19:16:21 +01:00
J. Ryan Stinnett
6df5c35b4e Move to labs doc 2019-05-01 19:16:21 +01:00
J. Ryan Stinnett
147c287acd
Fix typo in Settings docs 2019-04-26 10:45:13 +01:00
Ben Parsons
d098857d5a wrap text and link from README.md 2019-03-22 14:49:44 +00:00
Ben Parsons
ee85c04796 "Render simple counters in room header" details 2019-03-13 17:54:46 +00:00
J. Ryan Stinnett
fcaf0a5503 Recommend using the latest Node LTS version 2019-03-13 10:54:36 +00:00
J. Ryan Stinnett
1312ba537a Update scripts and docs to use yarn where appropriate
Most `npm` operations are replaced with `yarn`, which generally has better
behavior. However, steps like publish that write to the NPM registry are left to
`npm`, which currently handles these tasks best.
2019-03-12 11:06:57 +00: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
Paul Tötterman
f7f9d8bfc3 Take Mac into account in keyboard shortcuts
Signed-off-by: Paul Tötterman <paul.totterman@iki.fi>
2019-01-09 17:37:54 +02:00
Paul Tötterman
ff95952969 Start documenting keyboard shortcuts
I'm sure I don't know all of them.

Signed-off-by: Paul Tötterman <paul.totterman@iki.fi>
2019-01-09 17:37:54 +02: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
Aidan Gauland
95b09cde60 Reorder sections in translating documentation
Move "Editing existing strings" to after "Adding new strings".
2018-04-29 14:08:57 +12:00
Aidan Gauland
c26cde2f6f Correct npm command name in documentation
The `npm run` command `i18n-prune` is actually `prunei18n`.
2018-04-29 14:08:03 +12:00
Aidan Gauland
a8e578f5b8 Move and reword note about out-of-date dev setup
Replace an inline, parenthetical note about possible failures of the `npm run`
scripts with additional items in the Requirements section.
2018-04-21 21:52:56 +12:00
Aidan Gauland
6d74d5f8b7 Correct instructions to use the i18n scripts
As per code review feedback, we should use the npm run scripts i18n and
i18n-prune instead of editing the i18n JSON files directly.
2018-04-21 21:46:37 +12:00
Aidan Gauland
69bb020e5c Add instructions for changing translated strings
Add instructions to the developer documentation for proper housekeeping of the
translations when editing strings.
2018-04-15 22:42:58 +12:00
Matthew Hodgson
0b5fe1232f
Merge pull request #6137 from rbozhkova/patch-1
Fix typo
2018-02-13 17:32:50 +00:00
rbozhkova
db5f4193ec
Fix typo 2018-02-13 18:22:01 +01:00
Luke Barnard
cb235a29fa
Merge pull request #5613 from pafcu/simplify-translation
Refactor translations
2017-11-16 11:54:52 +00:00
pafcu
1e2e4397f7
Fix typo 2017-11-16 12:41:26 +01:00
Stefan Parviainen
ae6c985d39 Add missing backtick
Signed-off-by: Stefan Parviainen <pafcu@iki.fi>
2017-11-15 19:58:29 +01:00
Stefan Parviainen
fcd58a2544 Update translating docs 2017-11-14 22:50:27 +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
Matthew Hodgson
190811ac1c WIP 2017-10-23 00:57:02 +01:00
David Baker
f712804018 Add note about it apparently segfaulting on node 6 2017-10-19 11:13:42 +01:00
David Baker
4e31aea402 Switch to gen-i18n script 2017-10-19 10:53:02 +01:00
pafcu
9680bcb117 Implement reviewer suggestions 2017-10-03 18:22:58 +02:00
Stefan Parviainen
25cf115533 Update docs with _td() and some other recommendations
Signed-off-by: Stefan Parviainen <pafcu@iki.fi>
2017-09-27 22:01:56 +02:00
Marcel
71a0ced8a8 Update import and directory path
...in the Translations dev guide
2017-06-10 12:27:26 +02:00
David Baker
4f6b237fbc Update translation links to riot.im 2017-06-09 15:16:38 +01:00
Michael Telatynski
e7fc602b3d room link should be a matrix.to one 2017-06-03 21:54:45 +01:00
Matthew Hodgson
35a671d43c more i18n instructions 2017-05-26 22:45:14 +01:00
Travis Ralston
8ddf4ced64 Update translating.md: Minor suggestions
Primarily spelling, wording, and grammar. A little bit of formatting too.
2017-05-26 13:09:40 -06:00
Matthew Hodgson
09adfbd6d6 remove stale i18n instructions 2017-05-26 19:39:05 +01:00
David Baker
5356eab159 Correct docs
Change array.push guideline to not using _t at class-load time
which was probably the actual problem. Update guidelines to
include punctuation.
2017-05-26 13:16:36 +01:00
David Baker
6b6fa59f3e Squash merge https://github.com/vector-im/riot-web/pull/3636 2017-05-23 14:12:53 +01:00
Matthew Hodgson
c5032ba1bc Update theming.md 2017-01-18 22:46:12 +00:00
Matthew Hodgson
f20efc57f3 simple doc about theming 2017-01-18 17:05:13 +00:00
Kegan Dougal
9c8b540d14 Actually add the doc 2015-09-17 11:06:50 +01:00
Kegan Dougal
e991beb900 Add conferencing doc 2015-09-17 11:06:08 +01:00