You'll note that in the README.txt file, the first link labeled "Superfish library" points to the Superfish project page, as opposed to where the Superfish library files actually are.

For someone who has already installed and used Superfish 50 times, they might think "well, technically, there IS a link to the Superfish library within the project page, so it's just one more link."

But for a busy developer who's never installed it before, they wouldn't know that it requires BOTH a set of js files in the /sites/all/libraries/superfish folder AND a set of module files in /sites/all/modules/superfish. So that also should be clearer on the project page. For requirements, it lists only the library, but NOT the module. If both were listed, then it would be much clearer.

To summarize:

a. Update the README.txt file in the module to point to the library files URL instead of the Drupal project page.
b. Update the description on the project page to make it super clear that both a set of library files AND a set of module files are required.

superfish instructions

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

jeromewiley created an issue. See original summary.

jeromewiley’s picture

Issue summary: View changes
jwilson3’s picture

Category: Feature request » Task
Status: Active » Needs review
FileSize
1.17 KB

There is a link already in the readme, if you go down a bit further in the installation instructions section:

Installation instructions
-------------------------
1. Download and extract the Superfish library into the libraries directory
   (usually "sites/all/libraries").
   Link: https://github.com/mehrpadin/Superfish-for-Drupal/zipball/1.x

However, it is a valid point that the link in the readme doesn't match the link on the project page.

Here is a patch that fixes the link, and adds the jquery update dependency to the requirements section. Basically breaking the 7.x README file inline with the project page.

jwilson3’s picture

Title: Suggestion for documentation (README.txt) » Fix requirements and zipfile link in Superfish README

  • mehrpadin committed 7df5ce4 on 7.x-1.x authored by jwilson3
    Issue #2644322 by jwilson3, jeromewiley: Fix requirements and zipfile...
mehrpadin’s picture

Status: Needs review » Fixed

Hey everybody,

Patch applied, thank you.

Status: Fixed » Closed (fixed)

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