README - Documentation does not follow Drupal Documentation standards

Created on 21 March 2020, over 4 years ago
Updated 18 July 2023, over 1 year ago

Problem/Motivation

README - Documentation does not follow Drupal Documentation standards

Proposed resolution

Create a file that brings to README up to standards according to https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

Remaining tasks

Some current issues with the existing file:

  • Two lines prior to headings (except the first one)
  • Text manually word-wrapped within around 80 cols
  • Headings underlined with ===/--- to the length of the heading, followed by a blank line
  • Perhaps convert file to proper Mardown syntax and change file extension

TODO

  • Review patch

User interface changes

N/A

API changes

N/A

Data model changes

N/A

Release notes snippet

N/A

📌 Task
Status

Fixed

Version

3.0

Component

Documentation

Created by

🇺🇸United States volkswagenchick San Francisco Bay Area

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.

Production build 0.71.5 2024