8
0
Quellcode durchsuchen

Docs: Minor corrections to framework docs.

Piotrek Koszuliński vor 8 Jahren
Ursprung
Commit
e6f9b4930d
2 geänderte Dateien mit 11 neuen und 13 gelöschten Zeilen
  1. 9 11
      docs/framework/guides/overview.md
  2. 2 2
      docs/framework/guides/quick-start.md

+ 9 - 11
docs/framework/guides/overview.md

@@ -23,17 +23,15 @@ So, the answer is simple – you need to start using the framework as soon as ex
 
 The framework was designed to be a highly flexible and unopinionated platform for creating custom rich-text editing solutions. At the same time it meets several goals making implementing features as easy task as possible.
 
-* Plugin-based architecture. Everything is a plugin.
-* Unopinionated core.
-* Change based, collaboration ready editing engine. The editing engine implements Operational Transformation algorithms which, accompanied with additional mechanisms, allows implementing real-time collaboration.
-* Custom data model. The editing engine implements a custom data model, designed to best fit multiple goals such as real-time collaboration and complex editing features.
-* Virtual DOM. Special, editing oriented virtual DOM implementation, targeting hiding browser quirks from your sight.
-* Clean core / features separation.
-* Quality. 100% CC.
-* Extensible. Orthogonality of plugins. Event based architecture.
-* API-first, modular design.
-* Granular, reusable features. Features are implemented in a granular way which allows reusing and recomposing them which, in turn, makes it possible to customize and extend existing plugins.
-* Minimal configuration.
+* **Plugin-based architecture.** Everything is a plugin – even such crucial features as support for typing or `<p>` elements. You can remove them or replace with your own implementations to achieve fully customized results.
+* **Unopinionated core.** The core does minimal assumptions and can be controlled through the schema. This leaves maximum decisiveness to plugins and hence to you.
+* **Collaboration ready editing engine.** The editing engine implements [Operational Transformation](https://en.wikipedia.org/wiki/Operational_transformation) algorithms which, accompanied with additional mechanisms, allows implementing real-time collaboration.
+* **Custom data model.** The editing engine implements a custom data model, designed to best fit multiple requirements such as enabling real-time collaboration and complex editing features.
+* **Virtual DOM.** The editing engine features a custom, editing oriented virtual DOM implementation, targeting hiding browser quirks from your sight.
+* **Granular, reusable features.** Features are implemented in a granular way which allows reusing and recomposing them which, in turn, makes it possible to customize and extend the editor. For instance, the {@link features/image image feature} consists of over 10 plugins at the moment.
+* **Extensibility.** The entire editor architecture was designed for maximum flexibility. The code is event-based and highly decoupled allowing you to plug in or replace pieces that you want to change. Features know minimum about themselves and communicate in standardized ways.
+* **Quality.** All the official packages have extensive tests suites (100% code coverage is merely a stop to that). All the code have {@link api/index API docs}.
+* **Minimal configuration.** To avoid bloat, features have minimal configuration. Deeper changes in their behavior can be done by recomposing them with custom features.
 
 ## Framework structure
 

+ 2 - 2
docs/framework/guides/quick-start.md

@@ -92,7 +92,7 @@ npm install --save \
 Based on this packages we can create a simple app.
 
 <info-box>
-	We are using here [ES6 modules](http://exploringjs.com/es6/ch_modules.html) syntax.
+	We are using here ES6 modules syntax. If you are not familiar with it, check out this [article](http://exploringjs.com/es6/ch_modules.html).
 </info-box>
 
 ```js
@@ -248,7 +248,7 @@ class InsertImage extends Plugin {
 And add your new plugin to the `config.plugins` array. After rebuilding the application and refreshing the page you should see "InsertImage was initialized" logged on the console.
 
 <info-box hint>
-	We said that your `InsertImage` plugin relies on the image feature represented here by the `Image` plugin. We could add the `Image` plugin as a {@link module:core/plugin~PluginInterface#requires dependency} of your `InsertImage` plugin. This would make the editor initializing `Image` automatically before initializing `InsertImage`, so you would be able to remove `Image` from `config.plugins`.
+	We said that your `InsertImage` plugin relies on the image feature represented here by the `Image` plugin. We could add the `Image` plugin as a {@link module:core/plugin~PluginInterface#requires dependency} of your `InsertImage` plugin. This would make the editor initialize `Image` automatically before initializing `InsertImage`, so you would be able to remove `Image` from `config.plugins`.
 
 	However, this means that your plugin would be coupled with the `Image` plugin. This is unnecessary. They do not need to know about each other. And while it does not change anything in this simple example, it is a good practice to keep plugins as decoupled as possible.
 </info-box>