Add documentation for chat

trytond/doc/modules/ir/design/chat.inc.rst

@@ -0,0 +1,25 @@
+.. _model-ir.chat.channel:
+
+Chat Channel
+============
+
+A *Channel* stores the `model-ir.chat.message` linked to a
+:class:`~trytond.model.ChatMixin`.
+
+
+.. _model-ir.chat.follower:
+
+Chat Follower
+=============
+
+The *Follower* concept stores the `model-res.user` or *email* to
+notify for new message on the linked `model-ir.chat.channel`.
+
+
+.. _model-ir.chat.message:
+
+Chat Message
+============
+
+A *Message* stores the content posted to a `model-ir.chat.channel`.
+The audience property defines who can see the message.

trytond/doc/modules/ir/design/index.rst

@@ -25,6 +25,7 @@ The *Internal Resource Module* introduces the following concepts:
 .. include:: lang.inc.rst
 .. include:: message.inc.rst
 .. include:: note.inc.rst
+.. include:: chat.inc.rst
 .. include:: queue.inc.rst
 .. include:: rule.inc.rst
 .. include:: sequence.inc.rst

trytond/doc/ref/models.rst

@@ -1278,6 +1278,15 @@ avatar, if it's not set then no default avatar is generated.
    Generate a default avatar for each record using the field.
 
 
+ChatMixin
+=========
+
+.. class:: ChatMixin
+
+A mixin_ to activate a `model-ir.chat.channel` on any
+:class:`~trytond.model.ModelStorage` record.
+
+
 .. _mixin: http://en.wikipedia.org/wiki/Mixin
 .. _JSON: http://en.wikipedia.org/wiki/Json
 .. _UNION: http://en.wikipedia.org/wiki/Union_(SQL)#UNION_operator