Display help texts in dashboard and on module pages and documentation section
>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #3558688. --> Reported by: [breidert](https://www.drupal.org/user/135619) Related to !5 >>> <h3 id="summary-problem-motivation">Problem/Motivation</h3> <p>In the dashboard we want to show help texts with links to documentation in various places.</p> <p>However, we don't have a mechanism for modules to provide such help texts in Drupal.</p> <p><img src="https://www.drupal.org/files/issues/2025-11-19/Drupal-AI-Dashboard-png-1440%C3%973062--11-19-2025_10_08_AM.jpg" width="400" alt="Screenshot missing help texts"></p> <p>We also want to display documentation:</p> <p><img src="https://www.drupal.org/files/issues/2025-11-19/Drupal-AI-Dashboard-png-1440%C3%973062--11-19-2025_10_33_AM.jpg" width="400" alt="Screenshot Documentation"></p> <h3 id="summary-proposed-resolution">Proposed resolution</h3> <p>Each module could ship a file called <code>/[module_name].ai_documentation.yml</code>. Other modules could read these files to display the documentation links in their UIs.</p> <p>The YML file should be structured like this:</p> <pre>my_doc_page:<br>&nbsp; label: 'This page explains this awesome feature'<br>&nbsp; url: 'https://www.drupal.org/ai'<br>&nbsp; description: 'Optional text to be display under the url label'</pre><p>Note, this has to be decided elsewhere, but once decided, we have to implement it here.</p>
issue