-
Notifications
You must be signed in to change notification settings - Fork 25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Goals of the new developer documentation #2
Comments
@dennisameling I think the plugins and marketplace are now done so I have marked them completed. |
This issue has been mentioned on Mautic Community Forums. There might be relevant details there: https://forum.mautic.org/t/need-brief-introduction-into-plugin-mautic-development/24272/6 |
Most of this is now done, and the remaining sections have open issues in this repo. Closing this one. Yay! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We aim to replace the current developer documentation at https://developer.mautic.org/ with a new one on Read the Docs. These docs are to be put at https://mautic-developer.readthedocs.io.
Background
ddev start
and have DDEV set up everything for them automatically (PHP, database, MailHog, Mautic installation, etc.)The goal
By moving to Read the Docs, we hope to solve the pain points above and provide developers with a smooth experience when they work on or with Mautic.
The strategy
In order to reach our goal, we need to split up the work into various chunks. If you would like to write a certain section - or a part of it - please leave a comment in this issue, so that we know who's working on what. Your help is greatly appreciated!
Sections that need to be moved over:
* = Ideally, we'd like to have auto-generated REST API docs, so that they're always up to date. An attempt was made to make that happen, but at the moment of writing this doesn't seem worth the effort as Mautic next-gen will have auto-generated REST API docs right from the start.
The text was updated successfully, but these errors were encountered: