AImeos Documentation | Suggestions

Help for integrating the Laravel package
Forum rules
Always add your Laravel, Aimeos and PHP version as well as your environment (Linux/Mac/Win)
Spam and unrelated posts will be removed immediately!
User avatar
peter69
Posts: 71
Joined: 09 Jun 2022, 19:31

AImeos Documentation | Suggestions

Post by peter69 » 25 Nov 2022, 17:59

Hello, aimeos!

Thank you very much and congratulations on the great package you have created.

I know this may not be the place for this, but I wanted to provide a couple of recommendations to improve Laravel Aimeos documentation:

1. Update MKDocs theme: I see that for the current documentation, you are using MkDocs. I think that maybe you could use a theme with a more current design. I was looking and this one has a good design and great support from the community: https://github.com/squidfunk/mkdocs-material.

2. VuePress: redesigning the documentation using VuePress I think would be an excellent idea and certainly the best option. VuePress has many features that can benefit Laravel aimeos.

Here are some useful links:
https://vuepress.vuejs.org/guide/
https://www.freecodecamp.org/news/how-t ... be8a99045/

I've reviewed the documentation for some of the competitors, and they seem a bit more up-to-date than Aimeos. I think Laravel Aimeos is the best eCommerce package/framework, but I think the documentation can be improved/updated.

Again, thank you very much for the help you provide daily in this forum.

Best regards!

User avatar
aimeos
Administrator
Posts: 6908
Joined: 01 Jan 1970, 00:00

Re: AImeos Documentation | Suggestions

Post by aimeos » 26 Nov 2022, 11:56

The Aimeos forum is the best to discuss things ;-)

In fact, the Aimeos documentation layout already uses the Mkdocs material theme :-)
Only the header has been adapted and we've added Algolia instead of the Mkdocs JS-based search.

Indeed, VuePress looks a bit nicer but don't know if it's worth the work to switch.
We've adapted the docs theme a bit and now it looks more like VuePress :-)

What do you think?
Professional support and custom implementation are available at Aimeos.com
If you like Aimeos, Image give us a star

User avatar
peter69
Posts: 71
Joined: 09 Jun 2022, 19:31

Re: AImeos Documentation | Suggestions

Post by peter69 » 26 Nov 2022, 16:44

Hello!

Looks great!

I think you can change the green color for one related to the "brand" of Aimeos, I attach screenshots that may be of help

Thanks for taking into account the suggestions,

Regards!
Attachments
footer link hover.PNG
footer link hover.PNG (102.78 KiB) Viewed 498 times
footer h2 font size - font weight.PNG
footer h2 font size - font weight.PNG (99.41 KiB) Viewed 498 times
footer background color.PNG
footer background color.PNG (104.65 KiB) Viewed 498 times
variables.PNG
variables.PNG (6.83 KiB) Viewed 498 times
color aimeos.PNG
color aimeos.PNG (120.87 KiB) Viewed 498 times

User avatar
peter69
Posts: 71
Joined: 09 Jun 2022, 19:31

Re: AImeos Documentation | Suggestions

Post by peter69 » 26 Nov 2022, 16:52

Also, you may adjust the width of the footer:
Attachments
footer width.PNG
footer width.PNG (98.28 KiB) Viewed 498 times

User avatar
aimeos
Administrator
Posts: 6908
Joined: 01 Jan 1970, 00:00

Re: AImeos Documentation | Suggestions

Post by aimeos » 27 Nov 2022, 09:15

Can you please create a PR here?
https://github.com/aimeos/aimeos-docs

It's much easier to discuss changes based on actual code :-)

The CSS file is available here:
https://github.com/aimeos/aimeos-docs/b ... aimeos.css
Professional support and custom implementation are available at Aimeos.com
If you like Aimeos, Image give us a star

User avatar
peter69
Posts: 71
Joined: 09 Jun 2022, 19:31

Re: AImeos Documentation | Suggestions

Post by peter69 » 28 Nov 2022, 15:19

Done!

User avatar
peter69
Posts: 71
Joined: 09 Jun 2022, 19:31

Re: AImeos Documentation | Suggestions

Post by peter69 » 30 Nov 2022, 16:29

Hello Aimeos!

I have made a few pull requests and they have been approved.

I would like to know when the pull requests are published. or how is the process of posting the changes in the documentation? Some style improvements and the addition of "hot reloading" are not shown yet.

Also, I would like to report that when you click on the Google search results for "laravel aimeos documentation", it redirects to 2021.x version documentation. I think it should show the latest version by default.

I have attached reference images,

Best regards!
Attachments
laravel-aimeos-documentation-Buscar-con-Google.png
laravel-aimeos-documentation-Buscar-con-Google.png (101.9 KiB) Viewed 440 times
Aimeos-documentation.png
Aimeos-documentation.png (102.2 KiB) Viewed 440 times

User avatar
aimeos
Administrator
Posts: 6908
Joined: 01 Jan 1970, 00:00

Re: AImeos Documentation | Suggestions

Post by aimeos » 01 Dec 2022, 15:44

peter69 wrote: 30 Nov 2022, 16:29 I would like to know when the pull requests are published. or how is the process of posting the changes in the documentation? Some style improvements and the addition of "hot reloading" are not shown yet.
The documentation is generated manually because it also requires updating the Algolia search index. We've merged the "hot reloading" commit into the 2022 branch, generated the docs and published them now. The Algolia update is still missing.
peter69 wrote: 30 Nov 2022, 16:29 Also, I would like to report that when you click on the Google search results for "laravel aimeos documentation", it redirects to 2021.x version documentation. I think it should show the latest version by default.
Unfortunately, we have no control over which version Google is listing in their index because we have a version for each major release and can't redirect from older releases to the latest one automatically due to older documentation is required by users with older versions too.
Professional support and custom implementation are available at Aimeos.com
If you like Aimeos, Image give us a star

User avatar
peter69
Posts: 71
Joined: 09 Jun 2022, 19:31

Re: AImeos Documentation | Suggestions

Post by peter69 » 01 Dec 2022, 16:42

Great!

The addition of the "hot reloading" is now visible. However, the improvements are not reflected in the colors and style of the footer.

Also, I did some research and there are some good options to better manage the versions, please check the links below:

Mkdocs material - setting up versioning

Also, this "warning" option is widely used by other projects and I think it can also be considered:
Mkdocs material - version warning

Regards!

User avatar
aimeos
Administrator
Posts: 6908
Joined: 01 Jan 1970, 00:00

Re: AImeos Documentation | Suggestions

Post by aimeos » 02 Dec 2022, 08:42

peter69 wrote: 01 Dec 2022, 16:42 The addition of the "hot reloading" is now visible. However, the improvements are not reflected in the colors and style of the footer.
The "hot reloading" section has been merged into 2022 branch, the other ones are currently only in the master branch:
https://aimeos.org/docs/master/
Good to know, we will have a look at it! :-)
Professional support and custom implementation are available at Aimeos.com
If you like Aimeos, Image give us a star

Post Reply