AImeos Documentation | Suggestions

[peter69]

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!

[aimeos]

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?

[peter69]

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!

[peter69]

Also, you may adjust the width of the footer:

[aimeos]

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

[peter69]

Done!

[peter69]

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!

[aimeos]

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.

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.

[peter69]

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!

[aimeos]

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/

Mkdocs material - setting up versioning
Mkdocs material - version warning

Good to know, we will have a look at it!