Contrib.social

Provide link to README on project page?

Open on Drupal.org →
Created on 25 April 2025, 25 days ago

Problem/Motivation

It took me quite a while to figure out how to config this module: I could not find any information on the project homepage, nor in the issue list.

Finally I ended up looking in the code, for routes and other clues, until I opened README.md.

It would be very helpful if a link (e.g. in the block on the right-hand site) to the README could be provided on the Project Page , or a small remark under a heading 'Installlation': See README.

📌 Task
Status

Active

Version

1.1

Component

Documentation

Created by

🇳🇱Netherlands koosvdkolk

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

Comments & Activities

  • Issue created by @koosvdkolk
  • Comment 25 days ago →
    🇨🇦Canada star-szr

    Sorry for the trouble, I wish this was more standardized.

    I added a link to “View README” in the project sidebar under Resources, what do you think?

  • Comment 25 days ago →
    🇳🇱Netherlands koosvdkolk

    Looks great, thanks! Although personally I always look for a 'Installation/configuration' header in the main text. But just the README will also do I think.

  • Comment 25 days ago →
    🇨🇦Canada star-szr

    I appreciate the feedback!

    I have added a 'Usage' section on the project page, feedback welcome.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024