Commit Graph

519 Commits (5d7c71210ff3353362ffa0c6775c60979270bbde)

Author SHA1 Message Date
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