Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moved all transforms from README to it's own in docs folder #168

Merged
merged 1 commit into from
Jun 15, 2016

Conversation

andyfangaf
Copy link
Contributor

@andyfangaf andyfangaf commented Jun 13, 2016

Documentation in packages/shopify-codemod/README.md doesn't scale as we add more transforms. This PR simply separates them into a docs folder like so packages/shopify-codemod/docs/some-transform.md.

After this PR is merged you should write documentation for new codemods under the new docs folder.

/cc @lemonmade @GoodForOneFare @justinthec

@lemonmade
Copy link
Member

👍 Can you add an auto-generated markdown file as part of bin/create-transform, and teach bin/rename-transform to rename the doc file too?

@GoodForOneFare
Copy link
Member

There's a risk of this backing things up. I'll create a separate issue for updating the transforms, and merge this in now.

@GoodForOneFare GoodForOneFare merged commit 2ca4167 into master Jun 15, 2016
@justinthec justinthec deleted the segmented-codemod-docs branch June 15, 2016 17:26
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.

3 participants