-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Document some basic concepts #4087
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! I left some comments.
README.md
Outdated
|
||
Providers provide smart editor features, also known as IntelliSense. For example, this includes completion and hover information. It is not the same as, but often maps to [language server protocol](https://microsoft.github.io/language-server-protocol) features. | ||
|
||
Providers work on models. Some IntelliSense depends on the file URI. For example, for TypeScript to resolve imports, or for JSON IntelliSense to determine which JSON schema to apply to which model. So it’s important to choose proper model URIs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd use "auto-complete", afaik IntelliSense is a Visual Studio only term
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought it applied to Monaco editor too, as it was part of VS Code. Good to know this is not the case. :)
I changed it to editors features, as it’s not just auto-complete.
3e412ba
to
09a944d
Compare
Thanks! |
I think this captures the basics. I’m open to suggestions.
IMO this is brief enough to keep in the readme, but I can move it into
/docs/basic-concepts
or so and link that if that’s preferable.Closes #4084