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

Ensure docs for settings are up to date with the actual settings #20346

Open
1 task done
bjorn3 opened this issue Nov 7, 2024 · 0 comments
Open
1 task done

Ensure docs for settings are up to date with the actual settings #20346

bjorn3 opened this issue Nov 7, 2024 · 0 comments
Labels
admin read Pending admin review enhancement [core label] triage Maintainer needs to classify the issue

Comments

@bjorn3
Copy link

bjorn3 commented Nov 7, 2024

Check for existing issues

  • Completed

Describe the feature

Several of the settings listed in https://zed.dev/docs/configuring-zed have changed their default value compared to what is documented. There are also a fair amount missing entirely from this page. I had to look at the default setting file to find them instead. Rust-analyzer automatically generates the docs for all settings it has from the type definitions in the source code itself and also generates the preference list in the vscode extension metadata from the same type definitions. Maybe Zed could do the same. Or if that is not possible it could have a check that verifies that the settings in the source code and the docs are in sync with each other.

Environment

N/A

If applicable, add mockups / screenshots to help present your vision of the feature

No response

@bjorn3 bjorn3 added admin read Pending admin review enhancement [core label] triage Maintainer needs to classify the issue labels Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
admin read Pending admin review enhancement [core label] triage Maintainer needs to classify the issue
Projects
None yet
Development

No branches or pull requests

1 participant