Enhancement: Documentation & Top Level Menu Standardisation

[mageaustralia]

Hi @fballiano. It's obviously I work heavily with Claude Code. Part of my day to day work, I've started focusing a lot on using it to write documentation / user guides during implementation. Traditionally, especially in smaller organisations or freelance developers, user guides and documentation simply didn't happen due to time constraints.

Whilst I've been creating the Data Feed module, there's been certain areas that may not be immediately clear to someone who doesn't have the background with Magento or Ecommerce in general and since creating and updating documentation is now somewhat trivial using LLM's, I think it's an area that could potentially set Maho apart - Great documentation

Even though overall I don't like Theo, this video - the Elixir is kind of self-documenting. Now as LLM's become better and more prevalent in coding, I think it will be helpful to both the End Users and LLM's to have somewhat self-documenting modules & guides or at least a standardised system to provide those during development. It could be a link from the module to the Maho website for the Developer Docs / User Guides for each section.

https://youtu.be/iV1EcfZSdCM?t=1148

The other thing, is I'm sure you've seen Magento or even Wordpress or other open source systems where the top level admin menus become over-populated with every 3rd party module. I was hoping we could again, have a standardised '3rd party / Add-Ons / Extensions" menu where they live under there and no 3rd party modules should populate the top level menus on their own.

This is just me thinking out loud. Of course the project is yours so the decision is ultimately yours - these are just issues I've encountered in my real life experiences with Magento.

[fballiano]

Hi @mageaustralia, sorry for being super late answering this!

Even though overall I don't like Theo, this video - the Elixir is kind of self-documenting. Now as LLM's become better and more prevalent in coding, I think it will be helpful to both the End Users and LLM's to have somewhat self-documenting modules & guides or at least a standardised system to provide those during development. It could be a link from the module to the Maho website for the Developer Docs / User Guides for each section.

Is Elixir a format that could be integrated? I couldn't really find documentation on it in the PHP world, I've to say I don't love the format, in PHP probably there should be an extension to PHPdoc to do that, instead of replacing it with something else, at least at a first glance.

At the moment we have the website where I try to document every big thing we do and https://deepwiki.com/MahoCommerce/maho too which is also interesting and I guess in the long run it will become even more important (deepwiki or something else that will come up in the future)

The other thing, is I'm sure you've seen Magento or even Wordpress or other open source systems where the top level admin menus become over-populated with every 3rd party module. I was hoping we could again, have a standardised '3rd party / Add-Ons / Extensions" menu where they live under there and no 3rd party modules should populate the top level menus on their own.

I think the problem is the sloppyness of vendors, especially in the M1 era and wordpress... but with Maho I'm much stricter when it comes to approve stuff for the marketplace (which I hope will grow and make more sense) and the idea is to provide guidelines, more than technical restrictions which would be kinda complicated in this case. should be forbid people from creating new 1st-level menus? but it could make sense or be a customer-requirement in some cases.. so I guess it's a matter of education and, for example if a module wants to be in the marketplace and has the "base module" (which many venders use to spam or do license control) that's an automatic no...