ckeditor / ckeditor4-java-samples

The development repository of CKEditor for Java (web application).
9 stars 11 forks source link

Don't repeat the documentation in samples #9

Open wwalc opened 9 years ago

wwalc commented 9 years ago

The simpler the example is, the easier it is to extract the relevant bits for anyone who is trying to reuse the code from samples.

For example, the replaceTag sample has the following info which is completely superfluous:

screen shot 2015-08-31 at 17 26 43

It should be written only in a wiki page and a link to it should be placed.

wwalc commented 9 years ago

Another good example is replaceObjectEl. A lot of text that should be in the documentation only. The example should just have ${cke_instance} and a gentle mention that the rest is set in DispatchServlet.java

wwalc commented 9 years ago

Note: a good idea on how to fix it is to first complete the wiki documentation and then gradually replace repeated information with correct links.