Conversation
ryanhagerty
left a comment
ryanhagerty
left a comment
There was a problem hiding this comment.
Great job Patrick. I left a couple comments that may make it easier to read, but I leave it up to you since it's an opinion. LMK if you have any questions
USAGE.md
Outdated
| You will see the terms "Projects", "Systems" and "Variants" used throughout this documentation, so it's important for you to understand what they mean. | ||
|
|
||
| - **Project**: an implementation of an Emulsify starter, such as [emulsify-drupal](https://github.com/emulsify-ds/emulsify-drupal). | ||
| - **System**: a design system that defines components, and assets. Emulsify projects opt into using systems using cli commands. Once a system has been selected for a project, the system will mandate how components are organized, install required components/assets, and give developers the ability to find and install non-required components. |
There was a problem hiding this comment.
I had to reread the second item in this sentence:
"the system will mandate how components are organized, install required components/assets, and give developers the ability to find and install non-required components."
I think it might be the tense difference. How about:
"the system will mandate how components are organized, how required components/assets are installed, and give developers the ability to find and install non-required components."
USAGE.md
Outdated
|
|
||
| - **Project**: an implementation of an Emulsify starter, such as [emulsify-drupal](https://github.com/emulsify-ds/emulsify-drupal). | ||
| - **System**: a design system that defines components, and assets. Emulsify projects opt into using systems using cli commands. Once a system has been selected for a project, the system will mandate how components are organized, install required components/assets, and give developers the ability to find and install non-required components. | ||
| - **Variant**: systems may have as many variants as they want. For example, a system might have a Drupal variant, a WordPress variant, and a React variant. The system is the same (imagine Material-UI is a system), but each variant may define different types of components, or have different organization patterns that are compatible with different platforms. |
There was a problem hiding this comment.
I would lead off with what a variant is, so:
"A system might have a Drupal variant, a WordPress variant, and a React variant. The system is the same (imagine Material-UI is a system), but each variant may define different types of components, or have different organization patterns that are compatible with different platforms. Systems may have as many variants as they want."
|
🎉 This PR is included in version 1.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
2 participants
No description provided.