Skip to content

(#1021) Provide clarity to choco sync command#1324

Merged
steviecoaster merged 1 commit into
chocolatey:masterfrom
imm0rtalsupp0rt:docs-maint
May 14, 2026
Merged

(#1021) Provide clarity to choco sync command#1324
steviecoaster merged 1 commit into
chocolatey:masterfrom
imm0rtalsupp0rt:docs-maint

Conversation

@imm0rtalsupp0rt
Copy link
Copy Markdown
Contributor

Description Of Changes

This commit provides recommended and alternate guidance, including a callout at the top of the page to alert users to the power of the command itself.

Motivation and Context

We get a lot of questions about how to run choco sync and this should provide the clarity requested.

Testing

  • I have previewed these changes using the Docker Container or another method before submitting this pull request.

Change Types Made

  • Minor documentation fix (typos etc.).
  • Major documentation change (refactoring, reformatting or adding documentation to existing page).
  • New documentation page added.
  • The change I have made should have a video added, and I have raised an issue for this.
    • Issue #

Change Checklist

  • Requires a change to menu structure (top or left-hand side)/
  • Menu structure has been updated
  • Images added to the img repository?
    • PR -
  • All items are complete on the Definition of Done.

Related Issue

Fixes #1021

@imm0rtalsupp0rt imm0rtalsupp0rt self-assigned this May 8, 2026
Comment thread src/content/docs/en-us/features/package-synchronization/sync-command.mdx Outdated
Comment thread src/content/docs/en-us/features/package-synchronization/sync-command.mdx Outdated
Comment thread src/content/docs/en-us/features/package-synchronization/sync-command.mdx Outdated
Comment thread src/content/docs/en-us/features/package-synchronization/sync-command.mdx Outdated
Comment thread src/content/docs/en-us/features/package-synchronization/sync-command.mdx Outdated
Comment thread src/content/docs/en-us/features/package-synchronization/sync-command.mdx Outdated
@steviecoaster
Copy link
Copy Markdown
Contributor

@imm0rtalsupp0rt Does this follow the new standard "shape" for docs? Is that codified somewhere? This PR is a good opportunity to introduce those changes. Otherwise, we'll touch this again in the future.

Comment thread src/content/docs/en-us/features/package-synchronization/sync-command.mdx Outdated
@imm0rtalsupp0rt
Copy link
Copy Markdown
Contributor Author

@imm0rtalsupp0rt Does this follow the new standard "shape" for docs? Is that codified somewhere? This PR is a good opportunity to introduce those changes. Otherwise, we'll touch this again in the future.

@steviecoaster this has some of the new shape I'm looking to implement. There are other changes for other parts of the documentation that have specific entries, such as versions of products, but this follows a structure that I think works across the majority of the docs. I haven't codified it yet, but I'm working on a list from the notes that I have and how the docs are written currently, and once I have one that I can share, I'm happy to do so.

Copy link
Copy Markdown
Member

@ryanrichter94 ryanrichter94 left a comment

Choose a reason for hiding this comment

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

I think you should add an additional section for the example below. Use the following code example to run choco sync against multiple installed software with a single command.

$mapping = @{
'Google Chrome' = 'googlechrome'
'Docker Dekstop' = 'docker-desktop'
'Microsoft Visual C++ v14 Redistributable (x64) - 14.50.35719'= 'vcredist140'
'Microsoft Visual Studio Code' = 'vscode'
}

$mapping.GetEnumerator() | Foreach-Object {choco sync --id="$($_.Key)" --package-id="$($_.Value)" }

Comment thread src/content/docs/en-us/features/package-synchronization/sync-command.mdx Outdated
Comment thread src/content/docs/en-us/features/package-synchronization/sync-command.mdx Outdated
Comment thread src/content/docs/en-us/features/package-synchronization/sync-command.mdx Outdated
@imm0rtalsupp0rt imm0rtalsupp0rt force-pushed the docs-maint branch 3 times, most recently from d9b252b to 1b50ee5 Compare May 13, 2026 15:02
@imm0rtalsupp0rt imm0rtalsupp0rt requested a review from JPRuskin May 13, 2026 16:58
We get a lot of questions about how to run `choco sync` and this commit provides clarity on how the command works, recommended and alternate usage guidance, and a callout at the top of the page to alert users to the power of the command itself.
Copy link
Copy Markdown
Contributor

@steviecoaster steviecoaster left a comment

Choose a reason for hiding this comment

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

LGTM

@steviecoaster steviecoaster merged commit f6f8c4a into chocolatey:master May 14, 2026
1 check passed
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.

Clarify sync command usage

5 participants