Add missing documentation to config parameters. #1619

Open
renegadespork wants to merge 5 commits from renegadespork/continuwuity:main into main
First-time contributor

Addresses issue #1544

Added documentation for the following:

  • pdu_cache_capacity
  • auth_chain_cache_capacity
  • shorteventid_cache_capacity
  • eventidshort_cache_capacity
  • eventid_pdu_cache_capacity
  • shortstatekey_cache_capacity
  • statekeyshort_cache_capacity
  • servernameevent_data_cache_capacity
  • stateinfo_cache_capacity
  • roomid_spacehierarchy_cache_capacity
  • max_fetch_prev_events
  • tracing_flame_filter
  • rocksdb_log_stderr
  • notification_push_path
  • freeze_legacy_media
  • test

Information referenced from:

Addresses [issue #1544](https://forgejo.ellis.link/continuwuation/continuwuity/issues/1544) Added documentation for the following: - `pdu_cache_capacity` - `auth_chain_cache_capacity` - `shorteventid_cache_capacity` - `eventidshort_cache_capacity` - `eventid_pdu_cache_capacity` - `shortstatekey_cache_capacity` - `statekeyshort_cache_capacity` - `servernameevent_data_cache_capacity` - `stateinfo_cache_capacity` - `roomid_spacehierarchy_cache_capacity` - `max_fetch_prev_events` - `tracing_flame_filter` - `rocksdb_log_stderr` - `notification_push_path` - `freeze_legacy_media` - `test` Information referenced from: - `/src/config/mod.rs` - [Conduit Docs](https://docs.conduit.rs/configuration.html) - [Matrix Specification](https://spec.matrix.org/v1.9/server-server-api/) - Variable references in the code.
docs: Added config documentation for the remaining undocumented variables.
Some checks are pending
Check Changelog / Check for changelog (pull_request_target) Waiting to run
Documentation / Build and Deploy Documentation (pull_request) Blocked by required conditions
Checks / Prek / Pre-commit & Formatting (pull_request) Blocked by required conditions
Checks / Prek / Clippy and Cargo Tests (pull_request) Blocked by required conditions
d48f2ebdf1
renegadespork force-pushed main from d48f2ebdf1
Some checks are pending
Check Changelog / Check for changelog (pull_request_target) Waiting to run
Documentation / Build and Deploy Documentation (pull_request) Blocked by required conditions
Checks / Prek / Pre-commit & Formatting (pull_request) Blocked by required conditions
Checks / Prek / Clippy and Cargo Tests (pull_request) Blocked by required conditions
to 339fa08947
Some checks are pending
Documentation / Build and Deploy Documentation (pull_request) Blocked by required conditions
Checks / Prek / Pre-commit & Formatting (pull_request) Blocked by required conditions
Checks / Prek / Clippy and Cargo Tests (pull_request) Blocked by required conditions
Check Changelog / Check for changelog (pull_request_target) Successful in 10s
2026-04-06 20:11:55 +00:00
Compare
nex 2026-04-06 20:16:38 +00:00

Please add a changelog fragment to changelog.d/ describing your changes.

<!-- changelog-check-action --> Please add a changelog fragment to `changelog.d/` describing your changes.
Jade force-pushed main from 339fa08947
Some checks are pending
Documentation / Build and Deploy Documentation (pull_request) Blocked by required conditions
Checks / Prek / Pre-commit & Formatting (pull_request) Blocked by required conditions
Checks / Prek / Clippy and Cargo Tests (pull_request) Blocked by required conditions
Check Changelog / Check for changelog (pull_request_target) Successful in 10s
to ec052ede59
Some checks failed
Check Changelog / Check for changelog (pull_request_target) Successful in 33s
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m17s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 9m46s
2026-04-12 14:51:31 +00:00
Compare
Some checks failed
Check Changelog / Check for changelog (pull_request_target) Successful in 33s
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m17s
Required
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 9m46s
Required
Details
This pull request is blocked because it's outdated.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u main:renegadespork-main
git switch renegadespork-main
Sign in to join this conversation.
No reviewers
nex
No milestone
No project
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
continuwuation/continuwuity!1619
No description provided.