Problem/Motivation

The current module documentation is contained in a minimal README.txt file. The Drupal community has adopted README.md (Markdown) as the standard format for project documentation to provide better formatting and readability on Drupal.org and Git repositories.

Currently, the file lacks detailed instructions on installation, configuration, and usage.

Proposed resolution

  1. Rename README.txt to README.md.
  2. Rewrite the content using Markdown syntax.
  3. Expand the documentation to follow the Drupal.org README.md template.
  4. Include the following sections:
    • Introduction: Brief description of what the module does (adding soft hyphens to plain text fields like titles).
    • Requirements: List any dependencies (likely just Core).
    • Installation: Standard module installation steps.
    • Configuration:
      • Explain how to enable the feature on Content Types and Block Types.
      • Navigate to Structure > Content types > [Type] > Edit.
      • Navigate to Structure > Block layout > Custom block library > Block types > [Type] > Edit.
    • Usage:
      • Explain how the "Insert soft hyphen" button appears on entity forms.
      • Explain the visual highlighting of soft hyphens in the input field.
    • Maintainers: Current maintainer information.
Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

guido_s created an issue. See original summary.

scontzen’s picture

Assigned: Unassigned » scontzen

scontzen’s picture

Converted README.txt to README.md following the Drupal README.md template. Added sections for requirements, installation, configuration, usage (including Layout Builder), and maintainers. Deleted README.txt.

scontzen’s picture

Status: Active » Needs review
vanessane’s picture

Assigned: scontzen » vanessane

The instructions are clear and precise; really easy to follow. Great work!

vanessane’s picture

Assigned: vanessane » Unassigned
Status: Needs review » Reviewed & tested by the community

The instructions are clear and precise; really easy to follow. Great work!

guido_s’s picture

Status: Reviewed & tested by the community » Fixed

Thanks for fixing that line.
I added the MR to the merge train.

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

  • guido_s committed f1ec32d0 on 1.0.x authored by scontzen
    feat: #3575735 Convert README.txt to README.md and expand documentation...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.