biome-vscode icon indicating copy to clipboard operation
biome-vscode copied to clipboard

Published 20 hours ago • verified publisher icon biomejs

🐛 Outdated documentation

Open ematipico opened this issue 1 year ago • 2 comments

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

ematipico avatar Apr 02 '24 08:04 ematipico

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.

nhedger avatar Apr 02 '24 12:04 nhedger

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.

ematipico avatar Apr 02 '24 14:04 ematipico

Closing in favor of https://github.com/biomejs/website/pull/974.

nhedger avatar Aug 22 '24 06:08 nhedger