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

USWDS-Site: Add clarity to Phase 2: compile instructions #2123

Merged
merged 17 commits into from Jul 28, 2023

Conversation

amyleadem
Copy link
Contributor

@amyleadem amyleadem commented Jun 6, 2023

Summary

Updated the guidance in Phase 2: Compile to add clarity by:

  1. Re-organizing content to more clearly identify which instructions are for uswds-compile users and which are for users who compile Sass a different way
  2. Updating the file names in the code demos to match what uswds-compile creates
  3. Adding copy to clarify which files are project files and which are USWDS files

⚠️ The changelog date will need to be updated before merge.

Related 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

  • Confirm that there are no spelling or grammatical errors
  • Confirm the file names in the code samples matches what is generated by uswds-compile
  • Confirm that the content order makes sense

- 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
@amyleadem amyleadem marked this pull request as ready for review June 21, 2023 23:23
Copy link
Contributor

@bonnieAcameron bonnieAcameron left a 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.

@bonnieAcameron
Copy link
Contributor

As an aside @amyleadem , do you think I could pick your brain about when/how/why you use code styling on your documentation? I think it's really useful and I think it would be smart to add it to a USWDS style guide or operationalize it in some way.

Copy link
Contributor

@mahoneycm mahoneycm left a 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!

amyleadem and others added 4 commits June 22, 2023 13:32
Co-authored-by: Bonnie Cameron <96838068+bonnieAcameron@users.noreply.github.com>
@amyleadem
Copy link
Contributor Author

@bonnieAcameron @mahoneycm
I've added some updates according to your suggestions. Will you take another look?

Also, @bonnieAcameron I would be happy to share whatever I know about code documentation. Let's find some time to chat.

Copy link
Contributor

@mahoneycm mahoneycm left a 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! 👍

Copy link
Contributor

@bonnieAcameron bonnieAcameron left a 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.

@amyleadem
Copy link
Contributor Author

@mejiaj I've made your requested changes. Let me know if you have any questions.

@amyleadem amyleadem requested a review from mejiaj July 10, 2023 21:11
Copy link
Contributor

@mejiaj mejiaj left a 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.

@amyleadem
Copy link
Contributor Author

@mejiaj A changelog entry is a good idea. Thanks! I've added an entry in 3854033. Let me know what you think.

@amyleadem amyleadem requested a review from mejiaj July 12, 2023 20:11
Copy link
Contributor

@mejiaj mejiaj left a 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.

@thisisdano thisisdano merged commit 0d2e712 into main Jul 28, 2023
8 checks passed
@thisisdano thisisdano deleted the al-update-compile-instructions branch July 28, 2023 17:06
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.

USWDS-Site - Confusion over setting up Sass entry point
5 participants