Below are some ideas for some areas of improvement around the documentation of the module:
Project page, could be a little bit more detailed:
1 - Project page description:
We could certainly add more information about the module's configuration.
- Introduction: one liner to let users know what this module does (200 chars max).
- Features: what the module can do.
- Implementation: how the module does what it does.
- Troubleshooting (Known Theme issues): For example, potentially conflicting modules, related with the Core User login pages or the login/authentication process.
- Review recommendations at: Project page template, Module documentation guidelines, Tips for a great project page, Best practices for creating and maintaining projects and README Template.
- Similar projects: other modules that do more or less the same things as this one.
- Many other sections: see the sections suggested by the Project page template, README Template and Tips for a great project page documents, for example, Troubleshooting, Known issues, Future developments, etc...
2 - Screenshots:
Consider adding screenshots that could demonstrate module's features:
- Backend settings form with all options expanded and example values in the fields.
- Front end display of the feature with the different routes overrides.
Examples of documented project pages:
Feel free to let me know if you would have any comments, feedback, questions, issues, objections, suggestions, additions or concerns on this task, I would surely be glad to provide more information or explain in more details.
Thanks in advance to everyone for your testing, reviews, feedback and comments on this issue.
Cheers!
Issue fork login_switch-3516159
Show commands
Start within a Git clone of the project using the version control instructions.
Or, if you do not have SSH keys set up on git.drupalcode.org:
Comments
Comment #2
drupalmatts commentedComment #6
dydave commentedThanks Matthew (@drupalmatts) for taking the time to look at this!
Glad to see the module's user base is growing steadily and hopefully the improvements to the project page should help new users better understand how to install and configure the module.
Thanks again for your great help keeping the module well maintained! 😊