[Meta] Improve documentation for Render and Form Elements

Created on 4 October 2022, about 2 years ago

Updated 4 September 2024, 4 months ago

Begginers at Drupal (such as myself) find it very hard to find information on how to properly apply in code and find detailed information on Form Elements and Render Elements. Most of the time we have to outsource to Stack Overflow and similar websites to find what we are looking for.

Improve the Classes documentation found in Form and render elements to make them more detailed about properties and attributes;
Improve Form render elements → and/or Form API → ;

[x] Decide on the scope of the issue, improve @docblocks and/or Form API guide;
- Both will be improved;
[x] Decide on the Documentation template, we worked on this Google Doc:
- The template proposed it is the one to be used on @docblocks;
[x] Decide where the guides will be placed inside the Wiki;
[x] Create another [Meta] issue to keep track of each element improvement;
[ ] Map other issues related to this in the comments, validate if they are truly related and link them as child to this issue;

All issues related to improving documentation of Render elements are being tracked in this spreadsheet.

🌱 Plan

Status

Active

Component

Missing documentation

Created by

🇧🇷Brazil GersonJL Pernambuco, Brazil

Live updates comments and jobs are added and updated live.

Incomplete comments

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024