docs: Document direct file editing for Claude in model/workflow skills#264
Merged
docs: Document direct file editing for Claude in model/workflow skills#264
Conversation
- Update swamp-model and swamp-workflow skills to recommend direct file editing - Claude can now use the Edit tool on YAML files instead of piping via stdin - Workflow: `get` → Edit tool → `validate` Closes #253
There was a problem hiding this comment.
Review: ✅ Approved
This is a documentation-only PR that simplifies the "Edit" sections in both swamp-model and swamp-workflow skill files. The changes recommend using Claude's native Edit tool for direct file editing rather than stdin/heredoc patterns.
What was reviewed:
- Code style compliance: N/A - documentation only, no TypeScript changes
- DDD principles: N/A - skill instruction files, not domain code
- Test coverage: N/A - documentation changes don't require tests
- Security: No concerns - no executable code changes
Observations:
- The recommended workflow (
get→ Edit tool →validate) is clear and consistent across both files - Important warnings (e.g., "Never modify the
idfield") are preserved - Alternative methods (interactive editor, stdin) remain documented for users who need them
- The
swamp repo indextip for stale search results is included
The PR achieves its goal of streamlining Claude's workflow for editing model and workflow files while maintaining backward compatibility documentation.
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
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.
get→ Edit tool →validateCloses #253