Following the Tutorial I wrote something like this to write the step:

    private void WriteStep()
    {
        var step = new Step
                       {
                           StepHtml = new StepHtml(WebDriver.PageSource),
                           StepDescription = new StepDescription
                                                 {
                                                     Title = WebDriver.Title,
                                                     Index = CurrentIndex
                                                 },
                           Page = new Page(WebDriver.CstPathAndQuery)
                       };
        ScenarioDocuWriter.SaveStep(UseCase.Name, Scenario.Name, step);

        var screenshot = WebDriver.GetScreenshot().AsByteArray;
        ScenarioDocuWriter.SaveScreenshot(UseCase.Name, Scenario.Name, step, screenshot);

        ScenarioDocuWriter.Flush();
        CurrentIndex++;
    }

After importing the result to Scenarioo, the screenshots were missing. Turns out that the ScreenshotFileName attribute of the StepDescription was missing. So I added the attribute:

    private void WriteStep()
    {
        var step = new Step
                       {
                           StepHtml = new StepHtml(WebDriver.PageSource),
                           StepDescription = new StepDescription
                                                 {
                                                     Title = WebDriver.Title,
                                                     Index = CurrentIndex,
                                                     ScreenshotFileName = new ScenarioDocuFiles(null).GetScreenshotFileName(CurrentIndex)
                                                 },
                           Page = new Page(WebDriver.CstPathAndQuery)
                       };
        ScenarioDocuWriter.SaveStep(UseCase.Name, Scenario.Name, step);

        var screenshot = WebDriver.GetScreenshot().AsByteArray;
        ScenarioDocuWriter.SaveScreenshot(UseCase.Name, Scenario.Name, step, screenshot);

        ScenarioDocuWriter.Flush();
        CurrentIndex++;
    }

Proposal: Derive the ScreenshotFileName property from the Step.Index property in the ScenarioDocuWriter.SaveScreenshot() method (if ScreenshotFileName is not set).

As a solution for issue #287 slashes and backslashes are disallowed in the C# API.

(this issue was moved here from the Scenarioo Viewer repository, see scenarioo/scenarioo#325)

most of the old tests are obsolete. go through them and check which one make sense in v3.

use https://github.com/tobiaszuercher/ServiceStack.Authentication.Layer/blob/master/appveyor.yml as a template, much easier to deal with versioning.

agreed with @felixmokross to use feature branches (we used to just have a single dev line).

the property "Labels" on the Scenario class was available in scenarioo 2.0 (resp. 0.1.6 to be precise) in C# library, but is missing now.

There is some logic around async writing of files. Review this part and try to find an easier solution for it.

https://github.com/scenarioo/scenarioo-cs/blob/master/Scenarioo/ScenariooTest/ScenariooTest/ScenarioDocuWriterTest.cs#L378

@bruderol shall we align the version number also in the writer library to match the scenarioo version?

i think it makes sense to align the first two number parts (Major, Minor) to indicate the alignment of the "feature level" with scenarioo.

eg: 2.1.x.y -> format supports all features of scenarioo 2.1.x

i'm not sure if we really need 4 numbers for the writer library. if so, then we use

x as the patch level,
y as the build counter

2.1.1.100 -> first patch
2.1.2.107 -> second patch

the build counter is shared across all branches that's why we may have holes. i'm not a big fan of that, but it's much easier to configure this way.

we could also do just 2.1.y for simplification (3 numbers are easier to read than 4 :))

use build number as indication for patches:
2.1.100
2.1.107 -> it's a higher build number -> bugfixes

what do you think?

cc: @adiherzog

Using a backslash in the destinationRootDirectory argument of the ScenarioDocuWriter led to a strange behavior (uncaught exception or something). Adding a second constructor taking a FileInfo as destinationRootDirectory would be great.

Wrong:

var scenarioDocuWriter = new ScenarioDocuWriter("E:\Scenarioo\", branch, build);

Correct:

var scenarioDocuWriter = new ScenarioDocuWriter("E:/Scenarioo/", branch, build);

Better:

var scenarioDocuWriter = new ScenarioDocuWriter(new FileInfo("E:/Scenarioo/"), branch, build);

For convenience:
It is very annoying when you can not simply type
.Details.addDetail("bla", "x")

The Java Writer Library supports such convenince (all details properties are per default initialized to empty details objects).

I think our Scenarioo-CS docu and NuGet Acocunt would need a little bit of love.

Issues to be solved:

• Outdated links in C# docu: see also PR #15

• C# docu should also link to our overal docu - e.g. this specific page that might be of interest: http://scenarioo.org/docs/master/tutorial/How-to-use-Scenarioo-Writer-Library.html and maybe to the examples listed here: http://scenarioo.org/docs/master/examples.html

• Outdated links on this page here: https://www.nuget.org/packages/Scenarioo-cs/

• Also some explanations on the NuGet package page are not anymore accurate (we talk of a "Scenarioo Writer" and not "Scenarioo API" anymore).

• We should avoid using Wikis and only link to MD files on our master branch ---> easier to update on new releases and versioned with the software.

@tobiaszuercher I started to do it, but it seems not to be so easy, so I had to stop ... maybe Metadata can only be changed with a new release? Linking the README.md from master branch into NuGet might be a good option? We do the same for npm here:
https://www.npmjs.com/package/scenarioo-js

Or what do you think?
In any case we should also update our README.md first!

What I already did: I migrated our nuget account to a Microsoft account for Scenarioo - since nuget accounts are deprecated - see Emails.