microsoft/language-server-protocol

Describe high-level concepts in the specifications page

Open

#881 opened on Dec 19, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)HTML (12,810 stars) (956 forks)batch import
clarificationcode lenshelp wanted

Description

The specification page mentions some concepts without introducing the concepts themselves.

For example, in the Code Lens Request section:

The code lens request is sent from the client to the server to compute code lenses for a given text document.

As a language server implementor I'm not necessarily familiar with these concepts, so a high-level explanation (or a link to a place where these concepts are described) and an example would help.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of LSPDocumentation writing skills
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the specification document to identify sections where concepts are introduced without explanation. For each such concept, draft a brief high level explanation and include an example. Consider linking to external resources for further reading. Ensure the additions follow the existing documentation style.
Describe high-level concepts in the specifications page · microsoft/language-server-protocol#881 | Good First Issue