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

fix: Preview build doc corrections #4053

Merged
merged 1 commit into from
Mar 13, 2024
Merged

fix: Preview build doc corrections #4053

merged 1 commit into from
Mar 13, 2024

Conversation

Gudahtt
Copy link
Member

@Gudahtt Gudahtt commented Mar 13, 2024

Explanation

The preview build documentation wrongly implied that the steps for using a local or preview build were different for MetaMask team members versus independent contributors. The steps are exactly the same.

Additionally, the examples that use npm have been removed. The override syntax listed was not correct (npm doesn't use the same syntax for the version specifier), and the other instructions all reference Yarn anyway so the document already doesn't make much sense for a reader only familiar with npm.

References

N/A

Changelog

None

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've highlighted breaking changes using the "BREAKING" category above as appropriate

The preview build documentation wrongly implied that the steps for
using a local or preview build were different for MetaMask team members
versus independent contributors. The steps are exactly the same.

Additionally, the examples that use npm have been removed. The override
syntax listed was not correct (npm doesn't use the same syntax for the
version specifier), and the other instructions all reference Yarn
anyway so the document already doesn't make much sense for a reader
only familiar with npm.
@Gudahtt Gudahtt marked this pull request as ready for review March 13, 2024 19:23
@Gudahtt Gudahtt requested a review from a team as a code owner March 13, 2024 19:23
Copy link
Contributor

@mcmire mcmire 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!

@Gudahtt Gudahtt merged commit 21d6027 into main Mar 13, 2024
139 checks passed
@Gudahtt Gudahtt deleted the fix-preview-build-docs branch March 13, 2024 21:38
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.

2 participants