Adds documentation for the workbench sync command#42
Merged
Conversation
- Users need to know how to keep their workbench up to date - Added Syncing Your Workbench section to top-level README - Added Sync section with flag table and examples to CLI README - Documented sync-specific error messages in CLI README Delivers #37
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
1 participant
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.
What does this PR do?
Adds comprehensive documentation for the new
workbench --synccommand to both the mainREADME.mdandpackages/workbench-cli/README.md. This update provides clear guidance on the command's purpose, detailing how it fetches and merges managed workbench files from the source repository to keep a local workbench up to date. It also includes usage examples, the underlying process for applying changes, prerequisites, and new troubleshooting entries.Relates to #36