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

Document some basic concepts #4087

Merged
merged 2 commits into from Jul 19, 2023
Merged

Conversation

remcohaszing
Copy link
Contributor

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

Copy link
Member

@hediet hediet left a 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 Show resolved Hide resolved
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.
Copy link
Member

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

Copy link
Contributor Author

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.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@hediet hediet enabled auto-merge July 19, 2023 14:08
@hediet
Copy link
Member

hediet commented Jul 19, 2023

Thanks!

@hediet hediet added this to the July 2023 milestone Jul 19, 2023
@hediet hediet merged commit 0f95ee0 into microsoft:main Jul 19, 2023
3 checks passed
@remcohaszing remcohaszing deleted the document-concepts branch July 19, 2023 17:48
@github-actions github-actions bot locked and limited conversation to collaborators Sep 2, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request] Explain basic concepts
3 participants