Skip to content

fix: CLI command text review #64

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

Merged
merged 18 commits into from
Aug 8, 2024
Merged

fix: CLI command text review #64

merged 18 commits into from
Aug 8, 2024

Conversation

moorejacqueline
Copy link
Collaborator

@moorejacqueline moorejacqueline commented Jun 18, 2024

What does this PR do?

Suggest revisions to --help text for lightning preview app and lightning preview site to make sure content aligns with CX standards.

What issues does this PR fix or reference?

@W-15924073@

@moorejacqueline moorejacqueline added the wip Work in progress label Jun 18, 2024
@moorejacqueline moorejacqueline requested a review from a team as a code owner June 18, 2024 23:09
Copy link
Contributor

@maliroteh-sf maliroteh-sf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Copy link
Collaborator

@khawkins khawkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of suggestions, but overall this seems good to me!

Copy link
Contributor

@jshackell-sfdc jshackell-sfdc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@moorejacqueline , the help looks awesome! Very nice job.

Most of my comments are either suggestions for adding a tad more information to help the user, or me being a bit confused about wording, possibly because I'm just not that familiar with LWC. I have a few direct edits, but nothing big.

Important: please make sure that the site.ts file is updated to show the command description (i added a comment) -- currently, because the crucial line was removed, the --help isn't showing any command description at all.

Happy to do a second review after you deal with my first review, but only if you want -- it's not necessary. Cheers!

@moorejacqueline moorejacqueline requested a review from nrkruk July 8, 2024 21:30
@moorejacqueline
Copy link
Collaborator Author

@nrkruk @jshackell-sfdc noticed the lightning.preview.component.md file, and we're wondering if we should remove it or leave it alone (since it sounds like we aren't supporting sf lightning preview component in 252). Thanks!

@moorejacqueline moorejacqueline force-pushed the moorejacqueline/revise-help branch from 9ee6c64 to 5b5336d Compare July 30, 2024 19:41
Copy link
Contributor

@jshackell-sfdc jshackell-sfdc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@moorejacqueline , see a few little edits, nothing big. Otherwise, the help looks great!

I'm sure devs are on it, but just for completeness, I noticed these two things:

Thanks!

FYI @nrkruk

Co-authored-by: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com>
@nrkruk nrkruk removed the wip Work in progress label Aug 8, 2024
@nrkruk nrkruk merged commit 0974dbb into main Aug 8, 2024
11 checks passed
@nrkruk nrkruk deleted the moorejacqueline/revise-help branch August 8, 2024 18:05
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.

5 participants