Docs review: Documentation for the Merge Requests Report Widgets architecture

Context

In the context of the Working Group for Merge Request Report Widgets, we set the Exit Criteria as follows:

• Shepherd the implementation and redesign of 10 extensions (full list) that will be ported to fully use the new shared MR Widget Extension Component.
• The shared component follows the Report regions design guidelines defined in the Pajamas Design System.
• The documentation reflects the capabilities of the shared component.
• Ensure there is clear documentation written for extending the component.

These are the page produced related to this effort:

• https://docs.gitlab.com/ee/development/new_fe_guide/modules/widget_extensions.html

There is also an established process in the context of Product to contribute to the MR experience:

• https://about.gitlab.com/handbook/product/cross-stage-features/merge-requests/

Design-wise, we have the Merge request reports page on design.gitlab.com:

• https://design.gitlab.com/regions/merge-request-reports/

As we approach the final rollout of the new widgets, we set our aims in ensuring the documentation is in shape to consider that exit criteria satisfied so we can close the Working Group and let it stand on its own.

Goal / Ask

Are the docs related to the MR Report Widgets extensions in good enough shape to guide future developers and interested people through development and maintenance of new/existing widgets?

If not, what's missing?

Note: We will request reviews from a Technical Writer and from an Engineer currently working on an upcoming widget.

References

Merged MR that introduced documentation requiring review:

• !79947 (merged)

Subsequent updates:

• !84723 (merged)
• !87107 (merged)

Related issue(s):

• #350290 (closed)