Sylius: [Documentation] User Guide - Community Effort

[CoderMaggie]

Hello dear community! 👋

I come to you first of all as the Product Owner of Sylius. Day by day we realize more that the thing we are missing most in our documentation is a User Guide.

May it be even basic, but present, so that our community (and even new Sylius organization members) will have a place to find out how to add a new product, new channel or to modify administrators data in the Sylius admin panel.

Another role I have in the Sylius community is Documentation Lead, and in this role I come to you asking:

❓ What articles would most useful for you in the User Guide? ❓

Think of people such as Customer Service, Administrators of different sections, Customers that are using either your Admin Panel or Shop.

Tell me what kind of operational advice are you looking for while trying to work with Sylius daily.

This is the first step to write the Sylius User Guide section of our docs as soon as possible, _with a little help from my friends_ 😃

The User Guide will be placed as a new chapter of the docs, alongside The Book, Cookbook etc. we will have The User Guide.

It will be divided into Shop and Admin guides. See below my proposed structure.

The User Guide
|___ Shop
     |___ How to register a new account?
     |___ How to change password?
     |___ How to ...?
|___ Admin
     |___ How to add a new product?
           |___ How to add variants of a product?
           |___ How to ...?
     |___ How to add new administrator?
     |___ How to ...?

What do you think? What are your suggestions?

[Roshyo]

Good idea !

IMO, we need a user guide about taxation and how it impact the price. The one displayed in admin and in shop. This is quite unclear, especially for the "included in price" part.
Also (still for taxation) the user guide should specify the "tax category" and "tax rate" separation. That's also quite confusing.

I'll post again in there if our customers ask us questions about the usage.

[bhargavmehta]

Hello,
It's a nice idea to have a End-User guide.
Is it possible to have all the use cases especially where there is something that can cause an error?
We can have a basic guide which can cover only basic framework and also adding few details on which plugins can help users to achieve basic functionalities needed by the site for eg., CMS plugin.
How about Basic hosting configuration needed to Run Sylius shop and preferable hosting providers?

Thank you

[gabiudrescu]

I would create this user guide from the business need of creating an ecommerce website based on Sylius. What do you need to take into consideration when you choose this platform for starting such a business.

Maybe you can choose the template of Jobeet adapted to the Sylius Shop where people can buy goodies such as stickers, pens or why not, even consulting hours.

[Niiko]

Hi,

I could help on that one, i have already do something like this, but in french (see cmonshop documentation.

It's kinda old (one year) and not in 1.2, and also for a "marketplace" (there are some extra features) but covers almost everything of core.

[pamil]

@CoderMaggie is it still relevant?