From 03d12cb44e087f4e26a9b068a865a725e50f24e6 Mon Sep 17 00:00:00 2001 From: strawberry Date: Tue, 21 May 2024 21:15:09 -0400 Subject: [PATCH] update docs a tad Signed-off-by: strawberry --- docs/development.md | 3 +-- docs/development/hot_reload.md | 2 +- docs/differences.md | 1 + docs/troubleshooting.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/development.md b/docs/development.md index 18cd6c2e..5bffa39b 100644 --- a/docs/development.md +++ b/docs/development.md @@ -16,8 +16,7 @@ look like this: RUSTFLAGS="--cfg tokio_unstable" cargo build \ --release \ --no-default-features \ - --features - backend_rocksdb,systemd,element_hacks,sentry_telemetry,gzip_compression,brotli_compression,zstd_compression,tokio_console + --features=rocksdb,systemd,element_hacks,sentry_telemetry,gzip_compression,brotli_compression,zstd_compression,tokio_console ``` [1]: https://docs.rs/tokio-console/latest/tokio_console/ diff --git a/docs/development/hot_reload.md b/docs/development/hot_reload.md index c5705d25..554d5d08 100644 --- a/docs/development/hot_reload.md +++ b/docs/development/hot_reload.md @@ -1,4 +1,4 @@ -## Hot Reloading ("Live" Development) +# Hot Reloading ("Live" Development) ### Summary diff --git a/docs/differences.md b/docs/differences.md index 5135c529..0f0716e1 100644 --- a/docs/differences.md +++ b/docs/differences.md @@ -153,6 +153,7 @@ Outgoing typing indicators, outgoing read receipts, **and** outgoing presence! - Interest in supporting other operating systems such as macOS, BSDs, and Windows, and getting them added into CI and doing builds for them - Add config option for disabling RocksDB Direct IO if needed - Add various documentation on maintaining conduwuit, using RocksDB online backups, some troubleshooting, using admin commands, etc +- (Developers): Add support for [hot reloadable/"live" modular development](development/hot_reload.md) - (Developers): Add support for tokio-console - (Developers): Add support for tracing flame graphs - Add `release-debuginfo` Cargo build profile diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 6f8dc1c2..59ee32c7 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -59,4 +59,4 @@ conduwuit can ping other servers using `!admin debug ping`. This takes a server #### Allocator memory stats -If using jemalloc (for now) and built with jemallocator's `stats` feature, you can see conduwuit's jemalloc memory stats by using `!admin debug memory-stats` +When using jemalloc with jemallocator's `stats` feature, you can see conduwuit's jemalloc memory stats by using `!admin debug memory-stats`