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
USWDS-Site: Add clarity to Phase 2: compile instructions #2123
Conversation
- Align names with the names generated in uswds-compile - Goal of minimizing confusion
- Update uswds-compile intro for clarity - Be more direct with custom sass build instructions
…date-compile-instructions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @amyleadem ! These changes are all so great. I have a small suggestion about paring down the wordiness on a list of steps, but other than that it looks fantastic.
As an aside @amyleadem , do you think I could pick your brain about when/how/why you use |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Checked over the instructions and they're definitely improved in my opinion! I appreciate you taking the time to do this.
- Content is free of spelling and grammar errors
- File names match the output files from
uswds-compile
- Content order is logical
I added one small comment about potentially adding a note on init instructions but looks good either way!
Co-authored-by: Bonnie Cameron <96838068+bonnieAcameron@users.noreply.github.com>
…swds/uswds-site into al-update-compile-instructions
- Added accidentally
@bonnieAcameron @mahoneycm Also, @bonnieAcameron I would be happy to share whatever I know about code documentation. Let's find some time to chat. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! I think that note along with the sample gulp.js
file should be more than enough to keep people on the right track! 👍
…date-compile-instructions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! The changes to this page make it so much more readable.
Co-authored-by: James Mejia <james.mejia@gsa.gov>
…date-compile-instructions
@mejiaj I've made your requested changes. Let me know if you have any questions. |
…date-compile-instructions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, content makes sense and is accurate. Should we add a changelog entry?
I tested:
- Content makes sense & is accurate.
- Zero broken links.
- Zero axe errors.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding this.
Summary
Updated the guidance in Phase 2: Compile to add clarity by:
uswds-compile
users and which are for users who compile Sass a different wayuswds-compile
createsRelated issue
Closes #2061
Preview link
Preview link: Phase 2: Compile
Problem statement
There is an opportunity to add clarity about which files will be provided by USWDS and which will need to be created by the user.
This issue was originally flagged in this Slack thread.
Testing and review
uswds-compile