diff --git a/config.sample.json b/config.sample.json index 751e2839c..1a26289f8 100644 --- a/config.sample.json +++ b/config.sample.json @@ -20,8 +20,10 @@ "defaultCountryCode": "GB", "showLabsSettings": false, "features": { - "feature_groups": "labs", - "feature_pinning": "labs" + "feature_pinning": "labs", + "feature_custom_status": "labs", + "feature_custom_tags": "labs", + "feature_state_counters": "labs" }, "default_federate": true, "default_theme": "light", diff --git a/docs/config.md b/docs/config.md index d0667a147..1e06c9d26 100644 --- a/docs/config.md +++ b/docs/config.md @@ -29,8 +29,7 @@ For a good example, see https://riot.im/develop/config.json. which should take priority and therefore the application cannot continue. 1. `features`: Lookup of optional features that may be `enable`d, `disable`d, or exposed to the user in the `labs` section of settings. The available optional experimental features vary from - release to release. Some of the available features are described in the Labs Feature section - of this README. + release to release. The available features are described in [labs.md](labs.md). 1. `showLabsSettings`: Shows the "labs" tab of user settings even when no `features` are enabled or present. Useful for getting at settings which may be otherwise hidden. 1. `brand`: String to pass to your homeserver when configuring email notifications, to let the diff --git a/docs/labs.md b/docs/labs.md index 579bb1e11..ff53e1a73 100644 --- a/docs/labs.md +++ b/docs/labs.md @@ -1,12 +1,29 @@ # Labs features Some notes on the features you can enable by going to `Settings->Labs`. Not exhaustive, chat in -[#riot-web:matrix.org] for more information. +[#riot-web:matrix.org](https://matrix.to/#/#riot-web:matrix.org) for more information. **Be warned! Labs features are not finalised, they may be fragile, they may change, they may be dropped. Ask in the room if you are unclear about any details here.** -## Render simple counters in room header +## Message pinning (`feature_pinning`) + +Allows you to pin messages in the room. To pin a message, use the 3 dots to the right of the message +and select "Pin". + +## Custom status (`feature_custom_status`) + +An experimental approach for supporting custom status messages across DMs. To set a status, click on +your avatar next to the message composer. + +## Custom tags (`feature_custom_tags`) + +An experimental approach for dealing with custom tags. Custom tags will appear in the bottom portion +of the community filter panel. + +Setting custom tags is not supported by Riot. + +## Render simple counters in room header (`feature_state_counters`) Allows rendering of labelled counters above the message list. @@ -28,5 +45,3 @@ Once enabled, send a custom state event to a room to set values: ``` That's it. Now should see your new counter under the header. - -[#riot-web:matrix.org]: https://matrix.to/#/#riot-web:matrix.org