Ver Fonte

Update troubleshooting.md

Shalvah há 4 anos atrás
pai
commit
466aa6282c
1 ficheiros alterados com 4 adições e 4 exclusões
  1. 4 4
      docs/troubleshooting.md

+ 4 - 4
docs/troubleshooting.md

@@ -1,5 +1,5 @@
 # Troubleshooting and Debugging
-This page contains a few tips to help you figure out what's wrong when Scribe seems to be malfunctioning.
+This page contains a few tips to help you figure out what's wrong when Scribe seems to be slow or malfunctioning.
 
 ## Update your installation
 First off, try updating your installed Scribe version. Maybe your problem is due to a bug we've fixed in a newer release. You can see a list of releases and major changes on [the changelog](https://github.com/knuckleswtf/scribe/blob/master/CHANGELOG.md).
@@ -7,6 +7,9 @@ First off, try updating your installed Scribe version. Maybe your problem is due
 - To update to the latest version, run `composer update knuckleswtf/scribe`.
 - To update to a specific version (example: 1.4.1), run `composer update knuckleswtf/scribe:1.4.1`.
 
+## Make sure you aren't matching `web` routes
+Routes defined in Laravel's web.php typically have the `web` middleware, leading to strange behaviour, so make sure you've correctly specified the routes to be matched in your config file. See [this GitHub issue](https://github.com/knuckleswtf/scribe/issues/47).
+
 ## Increase the verbosity
 By default, Scribe will try to keep going until it processes all routes and generates your docs. If it encounters any problems while processing a route (such as a missing `@responseFile`, or some invalid configuration leading to an exception being thrown), it will output a warning and the exception message, then move on to the next route.
 
@@ -18,9 +21,6 @@ Sometimes you may see a 500 `null` response shown in the generated examples. Thi
 ## Clear any cached Laravel config
 Sometimes Laravel caches config files, and this may lead to Scribe failing with an error about a null `DocumentationConfig`. To fix this, clear the config cache by running `php artisan config:clear`.
 
-## Make sure you aren't matching `web` routes
-Routes defined in Laravel's web.php typically have the `web` middleware, leading to strange behaviour, so make sure you've correctly specified the routes to be matched in your config file. See [this GitHub issue](https://github.com/knuckleswtf/scribe/issues/47).
-
 ## Clear previously generated docs
 Sometimes you may run into conflicts if you switch from one output type to another. While we try to prevent this happening, we don't guarantee it. In such cases, please try clearing the old docs generated from your previous run (`laravel` would be in `resources/docs` and `storage/docs`, `static` would be in `public/docs`) and then running again. We recommend copying these out to a different location, just to be safe.