My favorite feature on github.com is that when you browse to a project page, you are automatically shown the README.txt file for that project's current release. Not only does this present the user with the most relevant information right from the get-go, but it discourages project maintainers from omitting the README file altogether (tsk tsk!).

I'd love to see Drupal.org incorporate README files into the online documentation. Displaying the current README file on the project homepage would be - imho - the simplest way to improve Drupal documentation.

Any thoughts?

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Active » Closed (duplicate)

I would not necessarily think that *only* the README contents should be shown. Actually, let's continue discussion on #495418: Contrib module information architecture ideas, which contains many ideas for project pages.