Forms subjects : simplify / refactor / re-arrange whole documentation
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 136
- Forks
- 555
- Avg merge
- 4d 14h
- Merged PRs (30d)
- 4
Description
Form subjects in the documentation are discussed at several locations:
- /development/components/form
- /development/components/form/types-reference/
- /development/architecture/migration-guide/forms/
- /modules/creation/adding-configuration-page-modern/
- /development/architecture/migration-guide/forms/settings-forms/
We have also several example modules to show how to interact with forms.
Cross linking has been done (https://github.com/PrestaShop/docs/pull/1762) but improvements can be done :
- the page : /development/components/form has duplicated content with some of the others
- it may be difficult for a module developer to understand the differences between those documentations, example modules, ...
We should think about a new structure around forms & PrestaShop, maybe with 2 approaches:
- Forms & PrestaShop for core developers
- Forms & PrestaShop for module developers
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
Compare the form content across /development/components/form, /development/components/form/types-reference/, the forms migration-guide pages, and /modules/creation/adding-configuration-page-modern/. Start by identifying duplicated material and the different needs of core and module developers. Done means an agreed structure that separates those audiences and reorganizes or cross-links the listed documentation and examples accordingly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100