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

docs: add the right npm command regarding astro --help for examples' README.md files #6864

Merged
merged 2 commits into from
Apr 18, 2023

Conversation

lauthieb
Copy link
Contributor

@lauthieb lauthieb commented Apr 17, 2023

Changes

This PR adds the right npm command regarding astro --help for examples' README.md files.
UPDATE: no changeset following this advice in review: #6864 (review)

Current

CleanShot 2023-04-17 at 15 50 06@2x

Expected

CleanShot 2023-04-17 at 15 50 29@2x

Testing

There's no test because I'm just enhancing markdown files.

Docs

There's no docs added because that's only markdown files that will be generated when users will create a new project with astro CLI.

Thanks :)

@lauthieb lauthieb requested a review from a team as a code owner April 17, 2023 13:57
@changeset-bot
Copy link

changeset-bot bot commented Apr 17, 2023

⚠️ No Changeset found

Latest commit: 4646510

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the pkg: example Related to an example package (scope) label Apr 17, 2023
Copy link
Member

@bluwy bluwy left a comment

Choose a reason for hiding this comment

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

This change make sense to me. I think we need to indent the other rows' | characters so they're aligned as well. I also think the changeset can be removed as they doesn't affect the published packages

@lauthieb
Copy link
Contributor Author

This change make sense to me. I think we need to indent the other rows' | characters so they're aligned as well. I also think the changeset can be removed as they doesn't affect the published packages

@bluwy thanks for your review and pieces of advice!
I've updated this PR accordingly with this commit: 4646510

@lauthieb lauthieb requested a review from bluwy April 17, 2023 15:19
Copy link
Member

@yanthomasdev yanthomasdev left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for this @lauthieb. Feel free to merge when you're satisfied @bluwy 🙌

@lauthieb lauthieb changed the title docs: add the right npm command regarding astro --help for in examples' README.md files docs: add the right npm command regarding astro --help for examples' README.md files Apr 17, 2023
Copy link
Member

@bluwy bluwy 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! Thanks for making the changes

@bluwy bluwy merged commit 0c82e08 into withastro:main Apr 18, 2023
@lauthieb lauthieb deleted the docs/astro-help branch April 18, 2023 06:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: example Related to an example package (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants