[Question] Comprehensive Documentation

[gabbydgab]

Hi @giorgiosironi ,

I would like to know is there a (updated) comprehensive documentation for this library? I know that it's included in the old PHPUnit branch (version 4.8) but currently it is not maintained in the https://www.phpunit.de site.

I would like to contribute and help with the documentation and updates of this library.

Thanks, Gab

[giorgiosironi]

The documentation was originally included in the PHPUnit manual, but since then the package has been separated so PHPUnit won't have this documentation anymore. For new projects I usually go for Sphinx building documentation from text files in the docs/ folder like in here https://github.com/giorgiosironi/eris/tree/master/docs which becomes http://eris.readthedocs.io/en/latest/

But, I'm happy for suggestions about what is the easiest methods to keep that documentation alive in a form that is separated from the PHPUnit manual.

[gabbydgab]

We can do it also as a separate branch (gh-pages) but I'm not yet familiar on how to automate it; one of my to do to learn this 2017.

Probably we can start the list of feature from the current version 3.0. We can layout the chapters, topics, etc.

Thanks in advance.

[giorgiosironi]

To be fair porting the existing chapter 13 (https://phpunit.de/manual/4.8/en/selenium.html) with its contents would already be a success. Then it can be reworked and expanded, but the problem to be solved is just to set up a process for documentation, not also to write it all at the same time. Speaking of 3.0, I would drop the PHPUnit_Extensions_SeleniumTestCase part as it has been removed from this major version.

[MCMic]

Is there still no documentation?

It’s hard to find information on how to use PHPUnit-Selenium. I wanted to add code coverage, I find messages mentioning a "coverageScriptUrl" var but without documentation it’s hard to understand how to use that.