EspoCRM Documentation - Adding Examples

[esforim]

Finally did a Pull Request on the Git and planning to do more contribution in the future if it something that I can "easily do"
yuri

One of which is, I am planning to add in real working example in some of the field and would like to ask.

(1) if that sort of information redundant?
(2) won't get accept by the Developer/EspoCRM;
(3) should the added documentation easily copy/paste or should be explain in details if necessary;
(4) should image/screenshot be kept at a minimal (or none at all), or a screenshot is necessary whenever it is a complex issue.
(5) should the example be 1 level more informative.

Let give a real example:

https://docs.espocrm.com/administrat...ingconcatenate
Currently the code is documents is:

string\concatenate(STRING_1, STRING_2)

string\concatenate(STRING_1, STRING_2)

The update I'm planning to add is (will most likely use only exist default field).

string\concatenate(STRING_1, STRING_2)

Example:
string\concatenate(firstName, lastName, "- Phone:", phone)

So with the code above, both field is a default field but I should be using a more universe field, such as "name" and "description" which will work for most entity.

In relation to the "phone" part, this is what I mean by 1 level higher, some people may not know that you can concatenate more than just 2 field.

---

Not sure if this thread where we should discuss more about documentations or create a new thread instead. Below are just some names that may be interested in documentation (did a quick forum search, pardon me if I ping wrongly).

Previous discussion of documentation we usually just hijack the thread to bit off-topic.

murugappan MatLudlam telecastg tothewine peterberlin
rinorway
a

Here is a couple of thread that we discuss about documentation:

https://forum.espocrm.com/forum/gene...tion-resources
https://forum.espocrm.com/forum/anno...9980#post59980
https://forum.espocrm.com/forum/deve...mments-missing
https://forum.espocrm.com/forum/gene...tion-resources

[Kyle]

I am fairly new to EspoCRM and have found the documentation a bit sparse. I have resorted to crawling through the code to work things out, this is not always easy. Any working examples would be good. Small extensions possibly that add a small function or group of functions would be very helpful (they do not need to be useful extensions just contain working examples with minimal other code/config). The forum has a lot of helpful information but sometimes its very hard to work out what you need to search for to be able to get to the answer.

[item]

Hello,
sample must be correct

string\concatenate(firstName, " ", lastName )

sample give here : field and string

[esforim]

Ah yes, I'm slacking aren't I. To be fixed in the real documentations! But yurikuzn probably full on v6.0 at the moment so response will be "Never"