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.

Sign up for GitHub

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

Jump to bottom

Rewrite the Language Server docs page with an evergreen approach #6902

Open
Savio-Sou opened this issue Dec 20, 2024 · 0 comments
Open

Rewrite the Language Server docs page with an evergreen approach #6902

Savio-Sou opened this issue Dec 20, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Contributions welcome, read CONTRIBUTING.md for how-to vscode Noir Language Support VS Code extension

Comments

@Savio-Sou
Copy link
Collaborator

Savio-Sou commented Dec 20, 2024 •
edited
Loading

Problem

The current Language Server doc page confusingly documents some, but not fully what Language Server Protocol (LSP) features does Noir support: https://noir-lang.org/docs/dev/tooling/language_server

Happy Case

Rewrite the doc page to cover an evergreen minimum, i.e. how to:

  • Install
  • Configure
  • Start, and
  • Integrate

Noir's Language Server (i.e. not covering usage and features).

Alternative Happy Case

Continue with the usage-first approach and document all LSP features that Noir support.

Project Impact

Nice-to-have

Would you like to submit a PR for this Issue?

None
@Savio-Sou Savio-Sou added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Contributions welcome, read CONTRIBUTING.md for how-to vscode Noir Language Support VS Code extension labels Dec 20, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Noir Dec 20, 2024
@Savio-Sou Savio-Sou changed the title Update the Language Server docs page Rewrite the Language Server docs page Dec 20, 2024
@Savio-Sou Savio-Sou changed the title Rewrite the Language Server docs page Rewrite the Language Server docs page with an evergreen approach Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Contributions welcome, read CONTRIBUTING.md for how-to vscode Noir Language Support VS Code extension
Projects
Noir
Status: 📋 Backlog
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Savio-Sou