docs: render env var names in command-line flag docs - #391
Merged
Conversation
The env="..." attribute passed to <ParamField> isn't an officially supported Mintlify prop, so it was silently dropped and never actually rendered — readers had no visible way to see which environment variable corresponds to --transport, --port, --host, --allowed-hosts, --auth-token, --dsn, or --id except in the Quick Reference table at the bottom of the page. Add an explicit "Env: `VAR_NAME`" mention to each flag's own body so it's visible right where the flag is documented. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Improves the command-line documentation by making the environment variable name for each relevant flag visible directly in the flag’s own description, rather than relying on Mintlify’s unsupported env="..." prop rendering or the quick reference table.
Changes:
- Add explicit
Env: \VAR_NAME`text to the descriptions for--transport,--port,--host,--allowed-hosts,--auth-token,--dsn, and--id`. - Keep
--configand--demounchanged (no env var mapping).
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
env="..."attribute passed to<ParamField>indocs/config/command-line.mdxisn't an officially supported Mintlify prop (confirmed against Mintlify's docs — supported props arepath,type,required,deprecated,default,placeholder). It was silently dropped and never rendered, so readers had no visible way to see the corresponding env var for--transport,--port,--host,--allowed-hosts,--auth-token,--dsn, or--idexcept by scrolling to the Quick Reference table at the bottom.Env: \VAR_NAME`sentence to each flag's own body. Verified each var againstsrc/config/env.ts(TRANSPORT,PORT,DBHUB_HOST,DBHUB_ALLOWED_HOSTS,DBHUB_AUTH_TOKEN,DSN,ID) —--configand--demo` correctly have no env var and are left as-is.Test plan
src/config/env.tsto confirm each stated env var name is real.🤖 Generated with Claude Code