Write docs for Core component

[favour-chibueze]

We need to write documentation on the Core component.

https://devdocs.mautic.org/en/latest/components/core.html

[Peacesandy]

Hello @favour-chibueze and @RCheesley
Can I take this up, I'd like to work on it.

[RCheesley]

Awesome @Peacesandy please let us know if you need any guidance!

[Peacesandy]

Thank you!
Sure, how do I get started please, what is the core component all about?

[RCheesley]

@escopecz could you give any guidance here? The file was added by Alan when we initially started this repo.

[escopecz]

The CoreBundle is a basically the Mautic bundle. Other core bundles are adding some specific feature like Configuration, Category, User bundles. The Core bundle is the only bundle that must be present to have Mautic working. Basically, if there is a PHP class that is used in multiple other bundles, it's added to the CoreBundle. It's hard to describe it easily as it is huge but doesn't really do anything specific, really. It contains all the interfaces and abstract classes that other bundles are implementing and extending. It actually handles themes but that's pretty much the only visible feature it handles.

[Peacesandy]

Okay, thanks for the clarification @escopecz

[Peacesandy]

Hello @escopecz and @RCheesley any guidance on how I can set up the docs on my local machine or can I add the documentation via Github.

@favour-chibueze

[favour-chibueze]

Hello @escopecz and @RCheesley any guidance on how I can set up the docs on my local machine or can I add the documentation via Github.

@favour-chibueze

Have you tried using gitpod? @Peacesandy

[Peacesandy]

@favour-chibueze , I have cloned it to my local machine, should I go ahead and add the documentation and make a PR?

[favour-chibueze]

Yes, please

[Peacesandy]

Okay