Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EPIC] Write and adapt developer documentation for v9 #1846

Open
6 of 9 tasks
MatShir opened this issue May 6, 2024 · 3 comments
Open
6 of 9 tasks

[EPIC] Write and adapt developer documentation for v9 #1846

MatShir opened this issue May 6, 2024 · 3 comments
Assignees
Labels

Comments

@MatShir
Copy link
Contributor

MatShir commented May 6, 2024

We need to create the 9.x branch for the developer documentation, and populate it with the v9 added and changed content:

API documentation

Symfony layout

To do: better describe each item, how to organize it, how to integrate it into devdocs

@kpodemski kpodemski transferred this issue from PrestaShop/devdocs-site Jul 23, 2024
@kpodemski
Copy link
Contributor

kpodemski commented Jul 31, 2024

Requires a better understanding of the impact:

  1. Twig component: Make Header independent PrestaShop#33775
  2. Introduce ShopContext and EmployeeContext sub context services PrestaShop#33223 - before and after recommendations + improvements for the https://devdocs.prestashop-project.org/9/development/components/context/
  3. Changes to translations may require even more details, especially regarding the usage of a new translation method, possibly adding a way to easily export .xlf for a module, etc. (Fix applying special char on translations PrestaShop#30415, Use htmlspecialchars on trans parameters and deprecate _raw parameter PrestaShop#31900)
  4. Add to docs about ObjectModel: Fix untranslated field names on Attribute Group error messages PrestaShop#33624

To be continued.

@kpodemski
Copy link
Contributor

kpodemski commented Jul 31, 2024

Hooks to document:

  1. actionBackOfficeLoginForm
  2. actionEmployeeRequestPasswordResetForm
  3. actionPresentCategory
  4. actionPresentSupplier
  5. actionPresentManufacturer
  6. actionPresentStore

@kpodemski
Copy link
Contributor

Remember about adding Carriers page to the list of migrated pages (behind the feature flag).

@ibahloul-ps ibahloul-ps changed the title Write and adapt developer documentation for v9 [EPIC] Write and adapt developer documentation for v9 Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants