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

🐛 Outdated documentation #188

Closed
3 tasks
ematipico opened this issue Apr 2, 2024 · 3 comments
Closed
3 tasks

🐛 Outdated documentation #188

ematipico opened this issue Apr 2, 2024 · 3 comments
Labels
Enhancement Improves an existing feature Good first issue Help wanted External contributions are welcome

Comments

@ematipico
Copy link
Member

VS Code version

latest

Extension version

latest

Biome version

latest

Operating system

  • Windows
  • macOS
  • Linux

Description

The readme documentation is outdated. At the very bottom, the options are old and the new ones aren't listed.

Steps to reproduce

Just the readme

Expected behavior

It should list all the new added options

Does this issue occur when using the CLI directly?

Not sure / Not applicable

Logs

No response

@nhedger
Copy link
Member

nhedger commented Apr 2, 2024

I'm wondering whether the README should instead include a link to the documentation page on the website. This would make it easier to maintain it in a single place.

@ematipico
Copy link
Member Author

Having it in the readme allows people to read the documentation straight from VSCode, which would work offline, too. But it's nice to have.

I don't mind linking the website. However, we should always remember to update the documentation.

@nhedger nhedger added Enhancement Improves an existing feature Help wanted External contributions are welcome Good first issue and removed Triage labels May 9, 2024
@nhedger
Copy link
Member

nhedger commented Aug 22, 2024

Closing in favor of biomejs/website#974.

@nhedger nhedger closed this as completed Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement Improves an existing feature Good first issue Help wanted External contributions are welcome
Projects
None yet
Development

No branches or pull requests

2 participants