Skip to content

docs: update AddASetting guide - #20552

Open
Darius B. (journaltraces) wants to merge 2 commits into
microsoft:mainfrom
journaltraces:docs/update-add-a-setting
Open

docs: update AddASetting guide#20552
Darius B. (journaltraces) wants to merge 2 commits into
microsoft:mainfrom
journaltraces:docs/update-add-a-setting

Conversation

@journaltraces

Copy link
Copy Markdown

Updates doc/cascadia/AddASetting.md to match the current Terminal Settings Model implementation.

The guide previously described adding profile and global settings using older patterns, including manual setting declarations in Profile.h, manual copy/JSON handling in Profile.cpp, and standalone WINRT_PROPERTY declarations in TerminalSettings.h

This update documents the current settings-list and IDL-based architecture, including:

  • MTSM_PROFILE_SETTINGS
  • MTSM_GLOBAL_ONLY_SETTINGS
  • MTSM_WINDOW_SETTINGS
  • INHERITABLE_SETTING
  • INHERITABLE_PROFILE_SETTING
  • terminal-facing settings through IControlSettings / ICoreSettings
  • ControlProperties.h and TerminalSettings packaging
  • current ProfileViewModel projection patterns

Fixes #20550

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
There may be pipelines that require an authorized user to comment /azp run to run.

@journaltraces

Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

@lhecker Leonard Hecker (lhecker) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I did not cross-read against the old version, but the new version is overall good.

Comment thread doc/cascadia/AddASetting.md Outdated
Comment thread doc/cascadia/AddASetting.md Outdated
Comment thread doc/cascadia/AddASetting.md Outdated
Comment thread doc/cascadia/AddASetting.md Outdated
@journaltraces

Darius B. (journaltraces) commented Aug 19, 2026

Copy link
Copy Markdown
Author

I’ve pushed a commit addressing all four comments.

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.

AddASetting.md does not appear to be up-to-date

2 participants