docs icon indicating copy to clipboard operation
docs copied to clipboard

Add docs about inner working of ps_facetedsearch

Open matks opened this issue 6 years ago • 4 comments

Ps_facetedsearch is a widly used FO module, but the inner working is very complex. @PierreRambaud did a wonderful refacto of the module but I think we should put in the docs the knowged he gathered while fixing the bugs of the filtering engine.

matks avatar Jun 24 '19 14:06 matks

Should be here no? https://github.com/PrestaShop/ADR The documentation is only about architecture and technical behavior. 🤔

PierreRambaud avatar Jun 24 '19 16:06 PierreRambaud

The documentation is only about architecture and technical behavior. 🤔

It's already a lot of things 😄. The idea is to help anyone else who wants to dive in ps_facetedsearch code to fix a bug to understand what's going on, what are the main classes, the main steps, basically help newcomers get a broad vision of the insights of the module.

Maybe it can go in an internal docs/ folder inside the module if you think it should not go here ?

matks avatar Jun 24 '19 16:06 matks

wait for @eternoendless :D

PierreRambaud avatar Jun 24 '19 16:06 PierreRambaud

this tutorial can be interesting: https://www.webbax.ch/2017/09/25/prestashop-1-7-navigation-a-facettes-ep-35/

ttoine avatar Jul 30 '20 11:07 ttoine