Skip to content

Commit

Permalink
Merge pull request #10418 from vector-im/travis/features
Browse files Browse the repository at this point in the history
Describe our existing features better in documentation
  • Loading branch information
turt2live committed Jul 26, 2019
2 parents 55e2f18 + 83da5e6 commit 11c0e98
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 8 deletions.
6 changes: 4 additions & 2 deletions config.sample.json
Expand Up @@ -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",
Expand Down
3 changes: 1 addition & 2 deletions docs/config.md
Expand Up @@ -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
Expand Down
23 changes: 19 additions & 4 deletions 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.

Expand All @@ -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

0 comments on commit 11c0e98

Please sign in to comment.