PrestaShop / PrestaShop/docs

[Roadmap] Improve Modules section

Open
#1,320 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Epic
Dominant language
Scala
Stars
136
Forks
555
Avg merge
4d 14h
Merged PRs (30d)
4

Description

In general

Modules shat section should always take care of presenting 2 different use cases:

  • I build something in my module that is loaded and rendered outside of PrestaShop (like a new BO page)
  • I decorate / extend an existing page of PrestaShop, then some constraints apply

We should provide clear pages about “OK, you want to customize BO page Z ? add a block there and a field in this form? Here is the path you should follow, what to look for…”

Roadmap
  • Introduction ✅
  • Getting started ✅
Extension concepts
  • JS events on FO 🔴
  • Routing 🔴
  • Controllers
    • Front Controllers 🟠
    • Admin Symfony Controllers 🟠
    • Admin Legacy Controllers 🔴
  • Hooks 🟠
  • Payment modules 🟠
  • Carrier modules 🟠
  • Testing ✅
  • Core changes ✅
  • Selling your modules ➡️ removed in doc 8.x
  • Sample modules 🟠
Related questions

✅ = quite complete (although can always be improved)
🟠 = can be improved
🔴 = does not exist

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the current Modules documentation and the related issue #1204. Identify one missing extension-concept topic and define the page path and guidance needed for the two use cases; done means the selected roadmap item has a clear, actionable documentation page.

Written by the indexing model from the issue text.

Assessment

Tech stack
symfony
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.