RonasIT / laravel-swagger

Laravel-Swagger is a fully automate tool which allows to generate and save swagger-based documentation after successful completing your application's feature tests.
https://ronasit.com
MIT License
143 stars 42 forks source link

Evikulov/readme update #63

Closed EVikulov closed 1 year ago

EVikulov commented 2 years ago

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

Checklist:

DenTray commented 2 years ago

@EVikulov could you please rewrite the "Installation" block:

  1. Remove Composer/Laravel/Plugin headings
  2. Text about the Laravel 5.5. version should be decorated as Note
  3. The second point in the current Laravel heading should be simplified to Run php artisan vendor:publish
  4. Hightlight all class-related words (naespaces, classes, etc.) as a code (e.g. Http/Kernel.php)
  5. In the second point in the current Plugin heading please rewrite "Use" word to "Add"
  6. The third point in the current Plugin heading should be removed
  7. Rewrite the current sentence to "Add the following env variables"
  8. Remove fourth point about the env variables
  9. Hightlight "Please note that this way will be removed after updating PHPUnit up to 10 version (https://github.com/sebastianbergmann/phpunit/issues/4676)" as a note
  10. Rewrite the description annotation in the request class example
  11. Rewrite the field annotation from the @some_field to the real field from the class (@is_active)