Skip to content

docs(config): update example to include max_file_size - #3125

Merged
KuSh merged 1 commit into
rtk-ai:developfrom
derrik-fleming:docs/update-config-example
Aug 31, 2026
Merged

KuSh merged 1 commit into
rtk-ai:developfrom
derrik-fleming:docs/update-config-example

Conversation

@derrik-fleming

@derrik-fleming derrik-fleming commented Jul 21, 2026 •

Copy link
Copy Markdown

Summary

  • updates the configuration example in the documentation, it was incomplete and missing an expected value, max_file_size.

Test plan

adding the value to my config allowed rtk to successfully parse it

  • cargo fmt --all && cargo clippy --all-targets && cargo test
  • Manual testing: rtk <command> output inspected

Important: All PRs must target the develop branch (not master).
See CONTRIBUTING.md for details.

@CLAassistant

CLAassistant commented Jul 21, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@pszymkowiak pszymkowiak left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified this is a real bug, not just a cosmetic doc gap: copying the current docs example verbatim (with a [tee] section, no max_file_size) produces a hard TOML parse failure:

rtk: TOML parse error at line 17, column 1
   |
17 | [tee]
   | ^^^^^
missing field `max_file_size`

Root cause: TeeConfig::max_file_size (src/core/tee.rs) has no #[serde(default)], unlike the top-level tee field on RtkConfig which defaults only when the whole [tee] section is absent. So: no [tee] section → fine; [tee] section present but missing max_file_size → hard parse error, exactly what the previous docs example triggered.

With the PR's added line (max_file_size = 1048576, matching DEFAULT_MAX_FILE_SIZE in tee.rs), the same config parses cleanly. Minimal, accurate, one-line fix. Approving.

@KuSh
KuSh merged commit 2a49e52 into rtk-ai:develop Aug 31, 2026
3 checks passed
@rtk-release-bot rtk-release-bot Bot mentioned this pull request Aug 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants