dc9af9599e
Previously, to see an example of the documentation that can be produced by Spring REST Docs, users had to clone the repository and build one of the samples. This commit makes it easier to see what Spring REST Docs can do by updating the docs zip that's automatically published to docs.spring.io to include both the API Guide and the Getting Started Guide from the RESTful notes sample. Closes gh-112
Spring REST Docs 
Overview
The primary goal of this project is to make it easy to document RESTful services by combining content that's been hand-written using Asciidoctor with auto-generated examples produced with the Spring MVC Test framework. The result is intended to be an easy-to-read user guide, akin to GitHub's API documentation for example, rather than the fully automated, dense API documentation produced by tools like Swagger.
For a broader introduction see the Documenting RESTful APIs presentation. Both the slides and a video recording are available.
Learning more
To learn more about Spring REST Docs, please consult the reference documentation.
Building from source
Spring REST Docs requires Java 7 or later and is built using Gradle:
./gradlew build
Contributing
Pull requests are welcome. Please see the contributor guidelines for details.
Licence
Spring REST Docs is open source software released under the Apache 2.0 license.