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

Create a better programming documentation #10343

Closed
Aaron-Junker opened this issue Mar 20, 2021 · 1 comment
Closed

Create a better programming documentation #10343

Aaron-Junker opened this issue Mar 20, 2021 · 1 comment
Labels
Issue-Docs Documentation issue that needs to be improved Resolution-Duplicate There's another issue on the tracker that's pretty much the same thing.

Comments

@Aaron-Junker
Copy link
Collaborator

I know, that there are already issues about that the docs are outdated.

But this docs are more like manuals how to do something and not a kind of API reference. But that is what such a big project needs. I have zero view on how PT works, but I need this to implement Monaco Preview. I mean something like what does this file, this class or this variable. Most of this things are specified in the files itself, but there is't a overview.

An example what I call a good API Documentation: https://microsoft.github.io/monaco-editor/api/index.html

So maybe we should take a month were we skip a release to create documention that is up to date and good to understand.

@Aaron-Junker Aaron-Junker added Issue-Docs Documentation issue that needs to be improved Needs-Triage For issues raised to be triaged and prioritized by internal Microsoft teams labels Mar 20, 2021
@crutkas
Copy link
Member

crutkas commented Apr 14, 2021

#761 would be tracking item. Monaco is designed to be consumed into other items and extended which is why they have some great docs. Our goal is stability and getting the core in a proper state so we can easier add in / debug stuff. I know @dend on his journey to add in #4246 has mentioned this as well and i'm going to be working with him to improve this.

Understanding painful spots also helps us understand where to focus for short term gains would be good to know as well.

@crutkas crutkas closed this as completed Apr 14, 2021
@crutkas crutkas added Resolution-Duplicate There's another issue on the tracker that's pretty much the same thing. and removed Needs-Triage For issues raised to be triaged and prioritized by internal Microsoft teams labels Apr 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Issue-Docs Documentation issue that needs to be improved Resolution-Duplicate There's another issue on the tracker that's pretty much the same thing.
Projects
None yet
Development

No branches or pull requests

2 participants