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: update the cli document for --write and --fix options #449

Closed
wants to merge 3 commits into from

Conversation

unvalley
Copy link
Member

@unvalley unvalley commented May 23, 2024

Summary

⚠️ The change of this PR will be included in v1.8.0, so this PR should be merged with the release.

I've updated the documents except for cli.mdx and CHANGELOG.md.

Closes #398

Copy link

netlify bot commented May 23, 2024

Deploy Preview for biomejs ready!

Name Link
🔨 Latest commit a22e87a
🔍 Latest deploy log https://app.netlify.com/sites/biomejs/deploys/664ff378deafaf00091287b8
😎 Deploy Preview https://deploy-preview-449--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.

@unvalley unvalley changed the title docs: update the cli document for --write and --fix options docs: update the cli document for --write and --fix options May 23, 2024
@unvalley unvalley marked this pull request as draft May 23, 2024 18:42
@ematipico
Copy link
Member

We can create a label for these cases. Something like "next release". What do you think?

@unvalley
Copy link
Member Author

unvalley commented May 23, 2024

@ematipico
yeah, I'll do.
I think this kind of update will be necessary in the future, and there are some ways to do it, such as separating branches for next release and managing them in different PRs, so it might be something to consider. But IMO, actually what we need is auto update of the cli document depends on releases.

@ematipico
Copy link
Member

What you want to update are the other pages of the website that still use --apply. The reference CLI is code generated, and we have a workflow job that does that for us.

@ematipico ematipico closed this Jun 4, 2024
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.

📚 update for --write, --fix, --unsafe options and deprecation of --apply and --apply-unsafe
2 participants