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: improve guides, add 'Migrate from' page #134

Merged
merged 1 commit into from
Apr 24, 2024
Merged

Conversation

Conaclos
Copy link
Member

Summary

  • remove System Requirements section
    It is already specified in Supported platforms in the Manual Installation guide.
  • Fix some wordings
  • Add Migrate from ESLint and Prettier guide
  • Improve Manual Installation guide.

@Conaclos Conaclos requested a review from a team as a code owner April 23, 2024 15:19
Copy link

netlify bot commented Apr 23, 2024

Deploy Preview for biomejs ready!

Name Link
🔨 Latest commit 5bd841f
🔍 Latest deploy log https://app.netlify.com/sites/biomejs/deploys/6628d42493121d0007c28cd7
😎 Deploy Preview https://deploy-preview-134--biomejs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Conaclos Conaclos requested a review from a team April 23, 2024 15:20
@Conaclos Conaclos force-pushed the conaclos/update-guides branch 2 times, most recently from 3b7a90d to 5aa06db Compare April 23, 2024 15:24
## Installation

The fastest way to download Biome is to use `npm` or your preferred package manager. The CLI is also available as a [standalone executable](/guides/manual-installation) if you want to use Biome without installing Node.js.
The fastest way to download Biome is to use `npm` or your preferred package manager.
This requires Node.js v14.18 or newer.
Copy link
Contributor

Choose a reason for hiding this comment

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

Where does this info lies?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think it is just the script that launches biome. Not sure. @ematipico any idea?

Copy link
Member

Choose a reason for hiding this comment

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

That's exactly this. The information comes from our engine field. We have a tiny script that just reads os and arch, and launches the binary of the correct architecture.

https://github.com/biomejs/biome/blob/main/packages%2F%40biomejs%2Fbiome%2Fbin%2Fbiome

Copy link
Member Author

@Conaclos Conaclos Apr 23, 2024

Choose a reason for hiding this comment

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

I wonder if we could avoid this script by running a post install script that creates a synlink?

We should take a look at other packages that ship binaries such as esbuild.

@Conaclos Conaclos force-pushed the conaclos/update-guides branch from 5aa06db to 1debe31 Compare April 23, 2024 20:08
@Conaclos Conaclos force-pushed the conaclos/update-guides branch 3 times, most recently from 6ef1bca to de5b7ae Compare April 24, 2024 09:42
@Conaclos Conaclos force-pushed the conaclos/update-guides branch from de5b7ae to 5bd841f Compare April 24, 2024 09:42
@Conaclos Conaclos merged commit d3e2a79 into main Apr 24, 2024
3 checks passed
@Conaclos Conaclos deleted the conaclos/update-guides branch April 24, 2024 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants