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

[Docs] Clean-up docs about editors API for plugins #2933

Closed
pjasiun opened this issue Jan 12, 2018 · 2 comments
Closed

[Docs] Clean-up docs about editors API for plugins #2933

pjasiun opened this issue Jan 12, 2018 · 2 comments
Assignees
Labels
package:core type:docs This issue reports a task related to documentation (e.g. an idea for a guide).
Milestone

Comments

@pjasiun
Copy link

pjasiun commented Jan 12, 2018

We need to clean-up API Docs of the editor class and all related interfaces.

I think that EditorWithUi interface should extend Editor interface. I'm not sure if it is possible when Editor is a class, but it means that maybe Editor should also be defined as separated class and interface. Then, I hope, it will be possible to define that one interface extends another.

It should be also well described what is the difference between editing and UI parts of plugins and which interface should be used in each case. Also, plugins docs should be updated.

Related: https://github.com/ckeditor/ckeditor5-core/issues/115, https://github.com/ckeditor/ckeditor5-core/issues/113, #303, #327, #488.

@oskarwrobel
Copy link
Contributor

After #2930 Intro docs in ckeditor5 has changed because StandardEditor class was removed. It would be nice to verify this doc and check if everything is correct and up to date.

@Reinmar Reinmar self-assigned this Apr 11, 2018
@Reinmar
Copy link
Member

Reinmar commented Apr 12, 2018

I cleaned up API docs for these interface and the editor class. I think it's fine now.

@Reinmar Reinmar closed this as completed Apr 12, 2018
@mlewand mlewand transferred this issue from ckeditor/ckeditor5-core Oct 9, 2019
@mlewand mlewand added this to the iteration 16 milestone Oct 9, 2019
@mlewand mlewand added status:confirmed type:docs This issue reports a task related to documentation (e.g. an idea for a guide). package:core labels Oct 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package:core type:docs This issue reports a task related to documentation (e.g. an idea for a guide).
Projects
None yet
Development

No branches or pull requests

4 participants