Skip to content

Show the TOML key and env var on every config option - #394

Open
tillrohrmann wants to merge 1 commit into
mainfrom
config-toml-env-badges
Open

Show the TOML key and env var on every config option#394
tillrohrmann wants to merge 1 commit into
mainfrom
config-toml-env-badges

Conversation

@tillrohrmann

@tillrohrmann tillrohrmann commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

The reference page has no headings and no per-option anchors, so once you are a few Expandables deep nothing tells you that the field you are looking at is worker.invoker.abort-timeout.

Every option now carries a toml: badge next to the env: one that was already there, and clicking either copies it. Sections show their table header ([worker.invoker], [[ingress.kafka-clusters]]).

This also fills in the 41 options that had no badge at all: a whole array or map is settable from a single env var, so RESTATE_ROLES and friends now show one.

Verified by round-tripping both the TOML and the env form through restate-server --dump-config, and by checking that every env: badge matches its toml: badge under the documented rule.


Stack created with GitHub Stacks CLIGive Feedback 💬

@mintlify

mintlify Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
restatedev 🟢 Ready View Preview Sep 1, 2026, 7:53 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

The page has no headings or anchors, so once you are a few Expandables deep
nothing tells you the field you are looking at is worker.invoker.abort-timeout.
Every option now carries a `toml:` badge next to the `env:` one that was
already there, and clicking either copies it.

Also fills in the options that had no badge at all: a whole array or map is
settable from a single env var, so RESTATE_ROLES and friends now show one.

Verified by round-tripping both forms through `restate-server --dump-config`.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@gvdongen

gvdongen commented Sep 2, 2026

Copy link
Copy Markdown
Collaborator

The addition of this toml field is a good idea.
I would not add this custom css and js for copying it though. Mintlify often changes data classes/implementations, and this will eventually break or break unnoticed. I think it's okay to just let readers copy it manually.

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.

2 participants