Skip to content

Commit

Permalink
#37 documented JSDoc API Documentration again with a link to give fee…
Browse files Browse the repository at this point in the history
…dback about ScenariooJS
  • Loading branch information
bruderol committed Oct 9, 2016
1 parent 0d48e87 commit 0614cbf
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,11 +198,17 @@ There is also a `Backward DSL` that is only interesting for migrating from old s
In case you want to define your own custom DSL for your specific application under test, to be able to document and test it more easily, you are free to do so, by simply copying our Scenarioo Fluent DSL from this one simple javascript file here as a blueprint for your own DSL:
[fluentDsl.js](/src/dsl/fluentDsl.js)

### Generate and Browse Documentation
### Generate and Browse Scenarioo Documentation

Run your protractor tests (e.g. as explained in [Examples Readme](/example/README.MD)) to run the tests and generate scenarioo documentation data.
This documentation can then be browsed by using the [Scenarioo Viewer Webapp](https://github.com/scenarioo/scenarioo).

## ScenaeriooJS JSDoc API Documentation

You can run `$ gulp docu` in order to create a browseable JSDoc API documentation of ScenariooJS in directory `docu`.

Currently this documentation might not be optimal and not cover 100% of the features. Feel free to help us improving our documentation by doing a Pull Request or just ask us questions or give us feedback by creating a [Github Issue](https://github.com/scenarioo/scenarioo-js/issues/new?labels=feedback), we will try to help you.

## Migration Guide

This migration guide explains how to switch from SceanriooJS 1.x to ScenariooJS 2.x
Expand Down

0 comments on commit 0614cbf

Please sign in to comment.