Feature: Make a dedicated user guide page for reporting

[MohabMohie]

Should explain the different reports, link to the different reporting properties, and advise users which report is suited for which state (eg. allure for debugging, summary for ci/cd runs, extent if the team is used to it)

For video recording -> you don't need to use any method, it's a property that you can simply enable if you want.
Either create a custom.properties file under src/main/resources in your project, you'll find that the engine already created a Properties directory for you with some core files. Put your file inside that directory, and add this property
videoParams_recordVideo=true
This will inform the engine that you want to record videos and it'll do that by default and attach the videos to your allure report.

By default the engine opens the Summary Report after execution. You can open the allure report manually by running the generate_allure_report.bat or generate_allure_report.sh file from your project directory.

You can also configure the allure report to open automatically after execution by configuring this property in your properties file.
openAllureReportAfterExecution=true
And if you want to disable the summary report (though I don't recommend that, because it's much faster and much more portable) you can add this property
openExecutionSummaryReportAfterExecution=false
Noting that if your team is used to (or prefers) extent report you can also enable that via this property
attachExtentReportsToAllureReport=true

There are many more useful properties, and all of which can be configured programmatically. We have an open GitHub ticket to complete this section of our user guide, we would appreciate the help if you want to contribute.

Slack Message