search

imbo / behat-api-extension

API extension for Behat, used to ease testing of JSON-based APIs
MIT License
109 stars 42 forks source link

Move docs currently in README elsewhere #37

Closed christeredvartsen closed 7 years ago

christeredvartsen commented 7 years ago

This PR is work in progress with regards to moving the docs currently found in README.md elsewhere. As the number of steps increase the README file is not good enough as a source of documentation.

christeredvartsen commented 7 years ago

Currently I have only added docs for a couple of steps using Read the docs to see how it looks.

The docs currently written can be found here: http://behat-api-extension.readthedocs.io/en/issue-36-docs/

Do you have any feedback regarding this @Alex-D? Do you think moving the docs to Read the docs is an improvement? Current I only added two steps there, but you can see the outline and how TOCs are generated and so forth.

Alex-D commented 7 years ago

It seems to be a good idea since there is a search bar and a summary :)

Alex-D commented 7 years ago

For the moment, the doc is here: http://behat-api-extension.readthedocs.io/en/develop

christeredvartsen commented 7 years ago

Correct. It will stay that way until an official release includes the docs, then /en/latest will point to that release.