Update docs

docs/conf.py

@@ -57,6 +57,5 @@ master_doc = 'index'
 def setup(app):
     app.add_config_value('recommonmark_config', {
         'auto_toc_tree_section': 'Contents',
-        'auto_toc_maxdepth': 2,
     }, True)
     app.add_transform(AutoStructify)

docs/documenting.md

@@ -1,10 +1,10 @@
 # Documenting your API
 Scribe tries to infer information about your API from your code, but you can enrich this information in the config and by using annotations (tags in doc block comments).
 
-## Contents
-- [General API information](documenting-api-information.md)
-- [Endpoint metadata](documenting-endpoint-metadata.md) (endpoint group, title, description, authentication status)
-- [Headers to be sent in requests to the endpoint](documenting-endpoint-headers.md)
-- [Query parameters and URL parameters to be sent in requests to the endpoint](documenting-endpoint-query-parameters.md)
-- [Body parameters and files to be sent in requests to the endpoint](documenting-endpoint-body-parameters.md)
-- [Example responses returned from the endpoint](documenting-endpoint-responses.md)
+Here's some of the information you can customise:
+- [General API information](documenting-api-information.html)
+- [Endpoint metadata](documenting-endpoint-metadata.html) (endpoint group, title, description, authentication status)
+- [Headers to be sent in requests to the endpoint](documenting-endpoint-headers.html)
+- [Query parameters and URL parameters to be sent in requests to the endpoint](documenting-endpoint-query-parameters.html)
+- [Body parameters and files to be sent in requests to the endpoint](documenting-endpoint-body-parameters.html)
+- [Example responses returned from the endpoint](documenting-endpoint-responses.html)

docs/index.md

@@ -9,6 +9,12 @@ Generate API documentation for humans from your Laravel/Lumen/[Dingo](https://gi
 * [Whats new](whats-new.md)
 * [Migrating from mpociot/laravel-apidoc-generator](migrating.md)
 * [Documenting Your API](documenting.md)
+* [Adding general API information](documenting-api-information.md)
+* [Documenting endpoint metadata](documenting-endpoint-metadata.md) (endpoint group, title, description, authentication status)
+* [Specifying headers to be sent in requests to the endpoint](documenting-endpoint-headers.md)
+* [Documenting query parameters and URL parameters to be sent in requests to the endpoint](documenting-endpoint-query-parameters.md)
+* [Documenting body parameters and files to be sent in requests to the endpoint](documenting-endpoint-body-parameters.md)
+* [Documenting example responses returned from the endpoint](documenting-endpoint-responses.md)
 * [Generating Documentation](generating-documentation.md)
 * [Configuration](config.md)
 * [Helpful Tips](helpful-tips.md)