瀏覽代碼

Update docs

shalvah 5 年之前
父節點
當前提交
d05ad3784a
共有 3 個文件被更改,包括 1 次插入14 次删除
  1. 1 1
      docs/guide-getting-started.md
  2. 0 12
      docs/helpful-tips.md
  3. 0 1
      docs/index.md

+ 1 - 1
docs/guide-getting-started.md

@@ -115,7 +115,7 @@ Scribe tries to figure out information about your routes, but it needs more help
 Check out how to do this in the guide on [Documenting your API](documenting.html).
 
 ## Generate and publish
-After making changes as needed, you can run `php artisan scribe:generate` as many times as you want. You should also check out [this list of helpful tips](helpful-tips.html).
+After making changes as needed, you can run `php artisan scribe:generate` as many times as you want.
 
 When you're happy with how your documentation looks, you're good to go. You can add the generated documentation to your version control and deploy as normal, and your users will be able to access it as you've configured.
 

+ 0 - 12
docs/helpful-tips.md

@@ -1,12 +0,0 @@
-# Helpful Tips
-[IN PROGRESS]
-
-Also check out our [community wiki](https://github.com/knuckleswtf/scribe/wiki/Helpful-strategies-(snippets)) for a list of helpful extraction strategies.
-
-## Use a separate env for generating documentation
-- Response calls
-- Factory
-
-## Use your test database/ docs user
-
-## Minimize usage of route groups

+ 0 - 1
docs/index.md

@@ -22,7 +22,6 @@ Generate API documentation for humans from your Laravel/Lumen/[Dingo](https://gi
 * [Documenting possible responses returned from the endpoint](documenting-endpoint-responses.md)
 * [Generating documentation](generating-documentation.md)
 * [Configuration](config.md)
-* [Helpful Tips](helpful-tips.md)
 * [Troubleshooting and Debugging](troubleshooting.md)
 * [Advanced customization](customization.md)
 * [How this works](description.md)