ckeditor / ckeditor5

Powerful rich text editor framework with a modular architecture, modern integrations, and features like collaborative editing.
https://ckeditor.com/ckeditor-5
Other
9.49k stars 3.7k forks source link

Docs: Document the model structure of all features #1502

Open oleq opened 5 years ago

oleq commented 5 years ago

A follow–up of https://stackoverflow.com/q/54498805/1485219 (but also earlier questions on SO and Gitter).

I noticed that developers struggle to understand the structure of the content introduced by various features in the model. Understanding it requires browsing multiple *editing.js files and putting all things together, which takes time and does not feel straightforward.

Maybe we should come up with some:

cc @Reinmar @AnnaTomanek @wwalc

oleq commented 5 years ago

Or maybe this kind of docs should land here?

wwalc commented 5 years ago

Kinda related: https://github.com/ckeditor/ckeditor5/issues/1205