Viewing The Living Documentation

Once you have generated your documentation using the SpecFlow+ build step, select Overview |SpecFlow+ from the menu to view the documentation.

Sample Output

Layout and Navigation

Choosing Your Repository and Branch

Use the drop-downs at the top of the page to select your repository and branch:

Repository selector

Repository selector

Branch selector

Branch selector

You can also choose pull requests from the branch selector. Once you have selected a build, the date of the build is displayed at the top.

Note: If the date shown here is older than your last build, this may indicate that the SpecFlow+ build step failed. This can happen if the build task fails to update the cache. If this occurs, manually queue a new build, which should refresh the cache.

Navigating the Living Documentation

The feature explorer on the left depicts the structure of your specifications. Blue entries represent features and scenarios. Black entries are based on the file structure of your project.

Click on a scenario or feature (blue text) in the feature explorer to display the documentation generated for that scenario or feature in the area on the right.

Switching to Related Feature Files

If your source code (feature files) is stored in a Azure DevOps or GitHub repository, you can switch directly from the living documentation to the source feature files. You can then edit the feature files directly in Azure DevOps or on GitHub.

Note: If your feature files are stored in a source control provider that is not supported, this link is not displayed.

To switch to a feature file:

  1. Open the corresponding page in the living documentation.
  2. Click on Show source at the top of the page.
    Note: If your feature files are stored in a source other than Azure DevOps or GitHub, this option is not available.
  3. The corresponding source feature file in your code repository is opened. You can edit the file directly in Azure DevOps or GitHub.
    Note: You may need to merge any conflicts that arise from your edits.