docs: sync skills and README with recent workspace features - #25
Merged
Conversation
Recent PRs added a workspace cleanup lifecycle, shared repo workspace config, and creation hooks that were missing from the docs. Bring the README and both agent skills up to date: - README: document 'gx workspace clean/prune/protect/unprotect' and the '--no-hooks' flag, the '.gx/workspace.toml' / '.gx/workspace.local.toml' shared repo config (with pre/post-create hooks and layering), the shared-vs-personal onboarding save choice, and the new '[workspace] protected_branches' / '[workspace.clean]' settings. - gx-workspace-workflow: add a Clean Up section, cover lock/protect for in-progress work, and document useful creation flags (--from-staged, --no-cd, --no-hooks, --no-fetch). - gx-onboarding-workflow: cover shared-vs-personal config, hooks, and 'gx workspace sync'.
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.
Summary
Recent PRs added a workspace cleanup lifecycle, shared repo workspace config, and creation hooks, but the README and the two agent skills hadn't caught up. This PR brings all the documentation in line with what's on
maintoday.I created the workspace for this work with
gx workspace new docs/sync-skills-readme(dogfooding the tool).What changed
README
gx workspace clean/prune/protect/unprotectin the Workspace section (PR feat(workspace): add cleanup lifecycle (clean, prune, protect, unprotect) #24) and add a Cleanup safety note covering the structural protections (main/current/locked/protected) and the dirty/untracked/unpushed/no-upstream skips.gx workspace new --no-hooksflag..gx/workspace.tomlvs~/.config/gx/repos/<repo>/)..gx/workspace.toml/.gx/workspace.local.toml,copy_files,setup_script,[workspace.hooks](pre/post-create + placeholders/env vars), and the layer-merge precedence (PR feat(workspace): shareable repo workspace policy #21).[workspace] protected_branchesand[workspace.clean](threshold_days,auto) to Workspace Configuration.Skills
--dry-run, safety guarantees), lock/protect for in-progress work, and a Useful creation flags list (--from-staged,--no-cd,--no-hooks,--no-fetch). Expanded the trigger description for cleanup/prune/protect/lock requests.gx workspace syncfor copying files between workspaces. Expanded the trigger description.Accuracy notes
Only documented behavior that is actually wired up. The resolver also parses
default_branchandworkspace.update_strategyfrom.gx/workspace.toml, but those fields are not yet consumed by any command, so they are intentionally left undocumented.Testing
Docs-only change (README + skill markdown); no code touched.