diff --git a/conduwuit-example.toml b/conduwuit-example.toml index 7cc920932..1f9bb0b5e 100644 --- a/conduwuit-example.toml +++ b/conduwuit-example.toml @@ -2659,6 +2659,15 @@ #profile_key_import_mode = "on_registration" [global.experiments] +# Continuwuity's experimental features are frequently updated. +# If you got this configuration via a package manager, chances are it's outdated. +# Check out the configuration reference online to see a fresh version: +# https://continuwuity.org/reference/config.html#:~:text=global.experiments +# +# Please keep in mind that experiments are used to enable unstable features. +# You probably don't need to enable any of these unless you know what they are, +# and consequently know why you should enable them. + # MSC4155: Invite filtering # diff --git a/src/core/config/experiments.rs b/src/core/config/experiments.rs index 14d5d556f..c19b19ad0 100644 --- a/src/core/config/experiments.rs +++ b/src/core/config/experiments.rs @@ -3,7 +3,18 @@ use serde::Deserialize; /// Configuration for experimental features. #[derive(Debug, Deserialize, Default, Clone)] -#[config_example_generator(filename = "conduwuit-example.toml", section = "global.experiments")] +#[config_example_generator( + filename = "conduwuit-example.toml", + section = "global.experiments", + subheader = r##"# Continuwuity's experimental features are frequently updated. +# If you got this configuration via a package manager, chances are it's outdated. +# Check out the configuration reference online to see a fresh version: +# https://continuwuity.org/reference/config.html#:~:text=global.experiments +# +# Please keep in mind that experiments are used to enable unstable features. +# You probably don't need to enable any of these unless you know what they are, +# and consequently know why you should enable them."## +)] pub struct Experiments { /// MSC2815: Proposal to allow room moderators to view redacted event /// content