Check site-builder documentation for completeness

Created on 18 January 2023, about 2 years ago
Updated 4 April 2023, about 2 years ago

First of all congrats on the project. Very useful and organized

Problem/Motivation

The content editor can have more informations in the help section at /admin/help/advanced_email_validation. Today we already have an initial version but it can be improved with more useful information

Steps to reproduce

Proposed resolution

Update the hook help with highlights that can be useful for the CMS users

Remaining tasks

User interface changes

API changes

Data model changes

📌 Task
Status

Closed: works as designed

Version

1.0

Component

Code

Created by

🇧🇷Brazil renatog Campinas

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

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

  • Status changed to Needs work about 2 years ago
  • 🇦🇺Australia darvanen Sydney, Australia

    I'm going to copy something here I wrote for another module in the same situation to provide a bit more context:

    The help section is there to give more information to site builders in particular on how the module functions and how they can set it up. It should contain instructions on how to configure or use the module aimed at that audience.

    My preference is to provide contextual help wherever possible in field descriptions, widget descriptions etc. Only when there is something about the module that cannot be described in-situ should we reach for hook_help.

    I would encourage you to consider the site-builder documentation of this module as a whole and determine if it can be improved, with or without hook_help.

  • Status changed to Closed: works as designed about 2 years ago
  • 🇦🇺Australia darvanen Sydney, Australia

    As there has been no further interest in the site-builder documentation I must conclude that there is nothing valuable to add in this instance.

Production build 0.71.5 2024