Skip to content

docs(config): match the config file load order to the code - #500

Open
meop wants to merge 2 commits into
ghostty-org:mainfrom
meop:docs/config-load-order
Open

meop wants to merge 2 commits into
ghostty-org:mainfrom
meop:docs/config-load-order

Conversation

@meop

@meop meop commented Nov 3, 2026 •

Copy link
Copy Markdown

Two spots in the config docs don't match src/config/Config.zig, from ghostty-org/ghostty#14828:

  • File order. The docs list config.ghostty before config, so config would win. loadDefaultFiles loads config first and then config.ghostty, and its doc comment says the same. This swaps both lists.
  • config-file timing. The docs say includes are processed at the end of the current file. The config-file doc comment says they "do not take effect until after the entire configuration is loaded", and Config.load calls loadRecursiveFiles after the default files and CLI args. This changes that sentence, and says CLI flags are part of what loads first, so a key in an included file overrides the same CLI flag.

npm run lint and npm run build pass, run on a GitHub runner in my fork. I used Claude Code to read the source and make the edit.

🤖 Generated with Claude Code

loadDefaultFiles loads the legacy `config` first and `config.ghostty` second.
Config.zig also documents that `config-file` includes take effect after the
entire configuration is loaded, not at the end of the current file.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Nov 3, 2026

Copy link
Copy Markdown

@meop is attempting to deploy a commit to the Ghostty Team on Vercel.

A member of the Team first needs to authorize it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@meop
meop force-pushed the docs/config-load-order branch from f182ea0 to 479b324 Compare November 5, 2026 21:22

This branch has not been deployed

No deployments
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.

1 participant