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

Adding documentation for lsp, documentation #37

Merged
merged 2 commits into from
Sep 13, 2023
Merged

Conversation

lovestaco
Copy link
Contributor

@lovestaco lovestaco commented Sep 10, 2023

What type of MR is this?

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Doc Update
  • 🎨 Style
  • πŸ§‘β€πŸ’» Code Refactor
  • πŸ”₯ Performance Improvements
  • βœ… Test
  • πŸ€– Build
  • πŸ” CI
  • ⏩ Revert

Description

Adding documentation for LSP release

Important files to start review from

  • Ide/Editor support
  • Contribute to LSP

Added to documentation?

If documentation update is there then run make mkdocs once PR is in acceptable state.

  • πŸ““ make mkdocs
  • πŸ“œ README.md
  • πŸ™… no documentation needed

@shrsv
Copy link
Contributor

shrsv commented Sep 10, 2023

Overall TOC, I think we have two main sections now:

  1. Programmatic ally Executing an l2 file
  2. LSP Language services for L2 extension

You can have the other sections categorised properly under these two.

@shrsv
Copy link
Contributor

shrsv commented Sep 10, 2023

Launch the server using the following command:

We want to highlight our experience in how this works.

  1. Usually you need a separate process to keep it running
  2. One interacts using stdin/stdout with this server (link MS docs for support)
  3. Link to our extension code relevant to starting the server

@shrsv
Copy link
Contributor

shrsv commented Sep 10, 2023

The LSP server offers a custom method, `suggest/environmentVariables``, which provides autocompletion suggestions for environment variables. 

The symbol highlighting using backticks is messed up.

@shrsv
Copy link
Contributor

shrsv commented Sep 10, 2023

Along with Goto Example (user level help), link relevant section of the VSCode extension.

@lovestaco
Copy link
Contributor Author

Along with Goto Example (user level help), link relevant section of the VSCode extension.

Will add after merging

@lovestaco
Copy link
Contributor Author

Launch the server using the following command:

We want to highlight our experience in how this works.

  1. Usually you need a separate process to keep it running
  2. One interacts using stdin/stdout with this server (link MS docs for support)
  3. Link to our extension code relevant to starting the server

Will add the link to FE after merging
check out this section of our codebase.

@shrsv shrsv merged commit aee4ec2 into main Sep 13, 2023
1 check passed
LinceMathew pushed a commit that referenced this pull request Dec 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants