I'm working on it, however I'd need more information about module usage (I'm currently testing it). Looks like the readme.txt has changed a little since Drupal 5 branch, and information about settings is really outdated. Also third modules integration is a little bit messy..

I'm taking this, As I'm not vitiated with module usage I'm in position to write a txt suitable for newcomers.

CommentFileSizeAuthor
#3 nodewords_readme.patch16.16 KBilo

Comments

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented

As alternative, would not a book page be better than a README.txt?
The cons against a book page is that would describe something that depends upon the module version being installed; in other words, the book page could contain the correct text for who has version 6.x-1.3-beta5, or earlier versions.

ilo’s picture

ilo commented

Agree KiamLaLuno, definitely having a handbook page is going to be a requirement due to different version-based configurations. I'll start with a very basic readme.txt (from current version) pointing install instructions and also cross-link other issues (Third party integration, developers API and so) to the handbook pages.

I'd say, my english is not that good to write an error-free documentation, a grammar review might be required in any case.

ilo’s picture

ilo commented
StatusFileSize
new nodewords_readme.patch16.16 KB

Ok, I have removed all the content that might go into a handbook (it was also outdated) and leave a README.txt with instructions about the module, install/upgrade/configuration operations and so..

How to integrate the nodewords module with taggadelic, eg, should be reviewed, and makes more sense being a handbook page or a "integration.txt" than in the readme.txt file.

ilo’s picture

ilo commented
Status: Active » Needs review
avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Title: Readme.txt file is completely outdated.. » Readme.txt file is completely outdated
Status: Needs review » Fixed

I slightly changed the text by using footnotes, and committed the changed file in CVS.

Once again, thanks for your help.

Status: Fixed » Closed (fixed)

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