I assume we could probably try improving the documentation of the module.
Below are some ideas for some areas of improvements 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 configurations.
- 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.
- Installation and usage paragraph: how the module should be installed and configured.
- 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 functions:
- Backend settings of the filter/editor's profile with configuration options highlighted and annotated
- Wysiwyg profile configuration with Collapse Text's plugin highlighted and annotated
- Wysiwyg window with some of the collapse_text syntax in the background, with annotations
- Resulting node with collapsible text. An animated GIF would be ideal.
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!
Comments
Comment #2
dydave commentedObsolete: Closed in favor of #3246284: Improve Collapse text project page, README.md and Help documentation..