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(website): Getting Started and Formatter improvements #2379

Merged
merged 4 commits into from
Apr 9, 2024

Conversation

Conaclos
Copy link
Member

@Conaclos Conaclos commented Apr 9, 2024

Summary

This PR provides some minor improvements to the website docs:

  • Getting Started
    • Remove some redundancies: we claim several times that Biome is opinionated.
    • Remove the jsonc code sample.
      It doesn't add so much value.
    • format --write <files> is more natural to users and simplify its modification when copied on the CLI
    • Add a link to our dedicated CI action
  • Formatter
    • Merge general and language-specific options in a single code sample.
      Users reading this section for the first time might stop at the general options and wonder if Biome supports formatting options such as arrowParentheses.
      It seems better to put all the options in the same place.
      This also makes it easier to copy and paste the config.

Test Plan

Ci should pass.

@Conaclos Conaclos requested a review from a team as a code owner April 9, 2024 13:41
@github-actions github-actions bot added the A-Website Area: website label Apr 9, 2024
Copy link

netlify bot commented Apr 9, 2024

Deploy Preview for biomejs ready!

Name Link
🔨 Latest commit 0652a52
🔍 Latest deploy log https://app.netlify.com/sites/biomejs/deploys/66156675a403dd00082cbf9a
😎 Deploy Preview https://deploy-preview-2379--biomejs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 99 (🔴 down 1 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 93 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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

@Conaclos Conaclos changed the title Conaclos/website minor improvements docs(website): Getting Started and Formatter improvements Apr 9, 2024
@Conaclos Conaclos requested a review from a team April 9, 2024 13:49
Copy link
Contributor

@arendjr arendjr left a comment

Choose a reason for hiding this comment

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

👍

Copy link
Contributor

@togami2864 togami2864 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
Member

@SuperchupuDev SuperchupuDev left a comment

Choose a reason for hiding this comment

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

other than this LGTM

website/src/content/docs/formatter/index.mdx Outdated Show resolved Hide resolved
website/src/content/docs/formatter/index.mdx Outdated Show resolved Hide resolved
website/src/content/docs/formatter/index.mdx Outdated Show resolved Hide resolved
@ematipico
Copy link
Member

Reminder to copy this new content to biomejs/website repository :)

Co-authored-by: Nicolas Hedger <649677+nhedger@users.noreply.github.com>
@Conaclos Conaclos merged commit cb59268 into main Apr 9, 2024
10 of 11 checks passed
@Conaclos Conaclos deleted the conaclos/website-minor-improvements branch April 9, 2024 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Website Area: website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants