Add docs about inner working of ps_facetedsearch
Open
Nobody has claimed this yet.
question
- Dominant language
- Scala
- Stars
- 136
- Forks
- 555
- Avg merge
- 4d 14h
- Merged PRs (30d)
- 4
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the ps_facetedsearch FO module and any existing documentation, then review the filtering-engine knowledge gathered during the refactor and bug fixes. Done means the complex inner workings and relevant filtering behavior are documented clearly for future developers.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100