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

[Feature Request] Explain basic concepts #4084

Closed
2 tasks done
remcohaszing opened this issue Jul 17, 2023 · 1 comment · Fixed by #4087
Closed
2 tasks done

[Feature Request] Explain basic concepts #4084

remcohaszing opened this issue Jul 17, 2023 · 1 comment · Fixed by #4087
Labels
feature-request Request for new features or functionality

Comments

@remcohaszing
Copy link
Contributor

Context

  • This issue is not a bug report. (please use a different template for reporting a bug)
  • This issue is not a duplicate of an existing issue. (please use the search to find existing issues)

Description

On my repositories that contain Monaco editor, I sometimes get questions about Monaco editor from users who don’t understand some of the basic concepts. People think of it as a code editor, but really to use Monaco editor, people must have some basic understanding of:

  • URIs
  • Models
  • Editor instances
  • Providers
  • Disposables

A little write-up on this would be nice. I could provide one if you want. Just let me know if this belongs on the wiki or readme.

Monaco Editor Playground Link

No response

Monaco Editor Playground Code

No response

@remcohaszing remcohaszing added the feature-request Request for new features or functionality label Jul 17, 2023
@hediet
Copy link
Member

hediet commented Jul 18, 2023

A little write-up on this would be nice. I could provide one if you want. Just let me know if this belongs on the wiki or readme.

That would be very nice!

Maybe even some diagrams could help (see CONTRIBUTING.md for inspiration).

I'd like to avoid docs that outdate quickly though, as we don't have the resources to keep them updated. The concepts you mentioned are very unlikely to become stale, so I don't think that's going to become a problem.

I think it would be better to have another .md file in the repository (rather than having it in the wiki).

remcohaszing added a commit to remcohaszing/monaco-editor that referenced this issue Jul 18, 2023
@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
feature-request Request for new features or functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants