소스 검색

Fix docs TOC view

shalvah 5 년 전
부모
커밋
1bb36f5cd0
2개의 변경된 파일7개의 추가작업 그리고 13개의 파일을 삭제
  1. 7 7
      docs/documenting.md
  2. 0 6
      docs/index.md

+ 7 - 7
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).
 
-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)
+## 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)

+ 0 - 6
docs/index.md

@@ -9,12 +9,6 @@ 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 information about your API](documenting-api-information.md)
-  * [Specifying metadata about an endpoint](documenting-endpoint-metadata.md)
-  * [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)
 * [Generating Documentation](generating-documentation.md)
 * [Configuration](config.md)
 * [Helpful Tips](helpful-tips.md)