[PR #2843] Update path to profiles.json in documentation #25117

Closed
opened 2026-01-31 09:07:22 +00:00 by claunia · 0 comments
Owner

Original Pull Request: https://github.com/microsoft/terminal/pull/2843

State: closed
Merged: Yes


Summary of the Pull Request

The profiles.json file was moved from RoamingState to LocalState in PR #2298. This PR updates the documentation to reflect this change.

References

PR #2298

PR Checklist

  • Closes #xxx
  • CLA signed. If not, go over here and sign the CLA
  • Tests added/passed
  • Requires documentation to be updated
  • I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx

Detailed Description of the Pull Request / Additional comments

I searched through the documentation for references to RoamingState in relation to profiles.json and changed RoamingState to LocalState for such instances. The configuration example for adding a custom background could technically continue to reference the roaming path, but I felt it was best to change it to the local path since it referenced this path as the "same directory as your profiles.json file."

Validation Steps Performed

Documentation update only, so no validation was performed.

**Original Pull Request:** https://github.com/microsoft/terminal/pull/2843 **State:** closed **Merged:** Yes --- ## Summary of the Pull Request The `profiles.json` file was moved from RoamingState to LocalState in PR #2298. This PR updates the documentation to reflect this change. ## References PR #2298 ## PR Checklist * [ ] Closes #xxx * [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [ ] Tests added/passed * [ ] Requires documentation to be updated * [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx ## Detailed Description of the Pull Request / Additional comments I searched through the documentation for references to RoamingState in relation to `profiles.json` and changed RoamingState to LocalState for such instances. The configuration example for adding a custom background could technically continue to reference the roaming path, but I felt it was best to change it to the local path since it referenced this path as the "same directory as your `profiles.json` file." ## Validation Steps Performed Documentation update only, so no validation was performed.
claunia added the pull-request label 2026-01-31 09:07:22 +00:00
Sign in to join this conversation.
No Label pull-request
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#25117