Skip to content

docs: updated documentation for MVC component. - #245

Merged
adiati98 merged 24 commits into
mautic:5.xfrom
Teebarh:toyibat2
Mar 5, 2026
Merged

docs: updated documentation for MVC component.#245
adiati98 merged 24 commits into
mautic:5.xfrom
Teebarh:toyibat2

Conversation

@Teebarh

@Teebarh Teebarh commented May 19, 2025

Copy link
Copy Markdown
Contributor

This PR brings over the documentation for the MVC component, updates it to include new additions, and converts the format to reStructuredText (RST).

It addresses issue #99.

@RCheesley

Copy link
Copy Markdown
Member

@Teebarh please take a look at the failing build job. It gives you some insights into why you cannot see the MVC item on the menu.

@Teebarh

Teebarh commented May 21, 2025

Copy link
Copy Markdown
Contributor Author

Okay, I'll give it a look.

@RCheesley

Copy link
Copy Markdown
Member

Hi @Teebarh please review the feedback from @escopecz in the commit here: 5b0b900#r158199455

As I mentioned, this whole section needed to be reviewed and updated while reviewing the Mautic codebase, because we use Twig now instead of PHP views, and a whole lot of stuff has changed (e.g. using dependency injection).

So this PR needs to be updated to consider that, and provide the appropriate documentation accordingly.

@Teebarh

Teebarh commented May 28, 2025

Copy link
Copy Markdown
Contributor Author

I'll check it out and revert back accordingly. Thank you, Ruth!

@Teebarh
Teebarh requested a review from a team as a code owner December 2, 2025 00:19
@Teebarh
Teebarh requested review from adiati98 and favour-chibueze and removed request for a team December 2, 2025 00:19
@adiati98

Copy link
Copy Markdown
Contributor

@escopecz @shinde-rahul, can anyone help me to review the content here whenever you have time? TIA! ✨

Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated

@adiati98 adiati98 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mautic/core-team @RCheesley some links here aren't the same links that are used in the legacy docs. So, I'd like to confirm.

Also, most of our dev docs aren't in the same structure as the legacy. Some pages are combined (maybe because the contents per page are short?) and I don't know if they're correct. I need more info on how we'd like to structure the dev docs.

TIA! ✨

Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated
Comment thread docs/plugins/mvc.rst Outdated
escopecz
escopecz previously approved these changes Jan 30, 2026

@escopecz escopecz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@RCheesley RCheesley added this to the 5.2 milestone Feb 24, 2026

@escopecz escopecz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@adiati98
adiati98 merged commit 90c879d into mautic:5.x Mar 5, 2026
4 of 5 checks passed
@github-project-automation github-project-automation Bot moved this from 🔎 In review to 🥳 Done in Mautic's No/Low/Code Tasks Mar 5, 2026
@adiati98

adiati98 commented Mar 5, 2026

Copy link
Copy Markdown
Contributor

Thank you, @Teebarh, @escopecz & @RCheesley! 🚀

@adiati98

Copy link
Copy Markdown
Contributor

@RCheesley can you please add @Teebarh to docs at all-contributors? TIA! ✨

@RCheesley

Copy link
Copy Markdown
Member

@all-contributors please add @Teebarh for docs

@allcontributors

Copy link
Copy Markdown
Contributor

@RCheesley

I've put up a pull request to add @Teebarh! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🥳 Done

Development

Successfully merging this pull request may close these issues.

4 participants