Skip to content

Docs: Move legacy docs pages and add admonitions#292

Merged
RCheesley merged 29 commits intomautic:5.xfrom
adiati98:docs/move-legacy-docs
Feb 12, 2026
Merged

Docs: Move legacy docs pages and add admonitions#292
RCheesley merged 29 commits intomautic:5.xfrom
adiati98:docs/move-legacy-docs

Conversation

@adiati98
Copy link
Contributor

Description

This PR moves legacy docs pages to the new docs with details as follow:

  • Pages contain the main title and a note admonition that redirect readers to the legacy repository.

Linked issue

N/A

Screenshots or screen recordings


Refer to the README in the GitHub repository for further instructions on using the library, or review the code examples throughout this documentation.

API rate limiter
Copy link
Contributor Author

Choose a reason for hiding this comment

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

In the legacy repo, this is a standalone page: https://github.com/mautic/developer-documentation/blob/main/source/includes/_api_rate_limiter.md.

Can this be part of API intro here, or is it part of another page (if so, which one?), or should it be a standalone page as the legacy?

Copy link
Member

Choose a reason for hiding this comment

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

The API rate limiter was removed, actually - since 7 I think. But we should have it there for legacy reasons. I think it makes sense having it in the API intro but open to thoughts on that from the devs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@escopecz do you have any thoughts about this?

Copy link
Member

Choose a reason for hiding this comment

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

I'd remove it. One company added the feature and it was removed because there was no version of the library that would support new Symfony and PHP version. The company was notified about it in time and they didn't add a replacement so far. So I hope this feature won't be missed by anyone.

@@ -1,7 +1,15 @@
Channels
Copy link
Contributor Author

Choose a reason for hiding this comment

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

In the original version, "Channels" section is not available, and "Extending broadcast" sub-section in this page is a standalone page: https://github.com/mautic/developer-documentation/blob/main/source/includes/_plugin_extending_broadcasts.md.

Is this correct that "Channels" and "Extending broadcast" are in the same page?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, I think extending broadcasts should sit under channels, because it relates to sending emails, SMS etc which are all channels.

@adiati98 adiati98 marked this pull request as ready for review February 11, 2026 20:40
@adiati98 adiati98 requested a review from a team as a code owner February 11, 2026 20:40
@adiati98 adiati98 removed the request for review from a team February 11, 2026 20:40
@adiati98
Copy link
Contributor Author

@RCheesley @escopecz

I've moved all pages from the legacy repo. I have a couple of questions in the comments in the files, and I'd like you to:

  • Review if the pages structure are make sense and in flow. If not, please let me know how we want to structure them.
  • Let me know which pages/toctrees that we want to remove from docs.

TIA! ✨

Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

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

Couple of small ones, thanks so much for doing this grunt work @adiati98 !

@adiati98
Copy link
Contributor Author

adiati98 commented Feb 11, 2026

Thanks for the approval, @RCheesley! Once it's merged, I'm getting ready for the merge conflicts from the outstanding PRs. 😁 💪🏼

@RCheesley
Copy link
Member

GTG once we get a 👀 from a dev team member :)

Copy link
Member

@escopecz escopecz left a comment

Choose a reason for hiding this comment

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

I'm thinking whether we shouldn't drop the outdated docs, but it may help someone. Let's try this

@RCheesley RCheesley merged commit 388a32b into mautic:5.x Feb 12, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants