Improve Core reference > Components section
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 136
- Forks
- 555
- Avg merge
- 4d 14h
- Merged PRs (30d)
- 4
Description
- BO sidebar β
- Configuration storage β
- Controllers π΄ (see nice example https://developers.shopware.com/developers-guide/controller/)
- Context π
- Locales and currencies π΄
- Database π
- Global JS components π
- Helper classes π (need to be updated and Symfony alternatives documented)
- HelperForm β
- HelperList β
- HelperOptions β
- Router and dispatcher β
- Smarty Extensions π
- Console β
- Faceted search β
- Form π
- Grid π (needs to be updated)
- Hook π
- Classes like DataProvider, Repositories β¦ π΄ (see nice example https://devdocs.magento.com/guides/v2.4/extension-dev-guide/searching-with-repositories.html)
- Import β
- Mail templates β
- Images π΄ https://github.com/PrestaShop/docs/issues/1084
- Position updater β‘οΈ should move into Grid section
- TinyMCE β‘οΈ should move into JS components section
- Users π (see below)
- All JS components (like TinyMCE) π΄ a section for all JS
- Webservice π΄ should be a link to top section
- The Front-office π΄ document the Cart, the checkout processβ¦
- Prices π΄ see https://devdocs.magento.com/guides/v2.4/extension-dev-guide/price-adjustments.html
For Users: we need to document how FO users login, how BO users login, document the user properties and capabilities, customer addresses, customer carts... β¦
FO User is a Customer π΄ -> see nice example https://docs.sylius.com/en/latest/book/index.html#customers
β‘οΈ= must move or must be removed
β
= quite complete (although can always be improved)
π = can be improved
π΄ = does not exist
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 with the Core reference > Components section and review the unchecked topics, including Controllers, Context, Users, JavaScript components, and the Front-office. Follow the linked PrestaShop issues and external examples where relevant. Done means the missing sections are documented, outdated sections are updated, and items marked for moving or linking are handled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, symfony
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100