rewording & clarifications

CHANGELOG.md

@@ -1,126 +1,132 @@
 # Laravel Enso's Changelog
 
+# Laravel Enso's Changelog
+
 ## 4.6.0
 
-This release includes some improvements, bug fixes, and new features.
+This release includes improvements, bug fixes, and new features.
 
 ### Front-end
 
 #### money
-- improves focus & blur handling, fixes input event payload
-- adds the ability to have null value
+- improved focus & blur handling, fixed input event payload
+- added the ability to have null value
 
 #### select
-- adds debounce for addTag
+- added debounce for `addTag`
 
 #### tables
-- adds support for numbers
-- adds formatted filtered / count
-- moves pagination logic to the BE
-- adds support for selection controls
-- fixes pagination when full records info is false
+- added support for numbers
+- added formatted filtered / count
+- moved pagination logic to the BE
+- added support for selection controls
+- fixed pagination when *full records info* is false
 
 #### tasks
-- adds permissions to register
+- added permissions to register
 
 #### ui
 - announce a new release on every chunk load failed error
-- adds permissions to register ref enso-ui/tasks#6
-- fixes auth routes for guests
+- added permissions to register ref enso-ui/tasks#6
+- fixed auth routes for guests
 
 #### users
-- fixes avatar when no tooltip is needed
+- fixed avatar display when no tooltip is needed
 
 ### Back-end
 
 #### addresses
-- adds new addresses.created_by column; adds upgrade
+- added new `addresses.created_by` column; added upgrade
 - added PHPMD config
-- adds factories for Township, Locality and Region
+- added factories for `Township`, `Locality` and `Region`
 
 #### avatars
-- removes HasAvatar trait in favor of dynamic method & observer
+- removed `HasAvatar` trait in favor of dynamic method & observer
 
 #### cli
-- fixes routes stub
-- fixes UI route component imports
-- adds common default for the route for the menu config
+- fixed routes stub
+- fixed UI route component imports
+- added common default for the route for the menu config
 
 #### companies
-- adds policy for edit page
+- added policy for edit page
 
 #### core
-- removes HasAvatar trait
-- removes teams
-- binding Faker\Generator in production to Dummy laravel-enso/data-export#10
-- adds user profile policy
-- fixes import in login controller
-- adds namespace to tests
+- removed `HasAvatar` trait
+- removed the `laravel-enso/teams` dependency as the package can be added if required
+- binding `Faker\Generator` in production to Dummy laravel-enso/data-export#10
+- added user profile policy
+- fixed import in login controller
+- added namespace to tests
 
 #### data-export
-- fixes notification path
-- adds sync excel attaching ability
+- fixed notification path
+- added sync excel attaching ability
 - updated permission description in structure
 
 #### documentation
 - updated table docs: references to money vs number
-- Updates table documentation
+- other table documentation small updates
 
 #### files
-- fixes file path upgrade for projects that don't use data-import
+- fixed file path upgrade for projects that don't use data-import
 
 #### filters
-- resolves comparison operators enum from apps container for improved flexibility; ref laravel-enso/filters#4
+- resolves comparison operators enum from App's container for improved flexibility; ref laravel-enso/filters#4
 
 #### helpers
-- adds dummy
+- added dummy
 
 #### localisation
 - updated out of stock `ro` translation
 
 #### products
 - updated test namespace
-- updates routes for pictures
+- updated url for pictures (route name remains the same)
 
 #### roles
-- rolls back sync order removal
+- rolls back ordering removal for the `sync` command
 
 #### tables
-- improves support for numbers; moves pagination on BE
-- fixes test
-- adds 'selection' ability for global controls
-- selection works only on selectable table, and will send to the BE a selection payload with the selected rows
+- improved support for numbers; moved pagination on BE
+- fixed test
+- added 'selection' ability for global controls
+- selection works only on selectable tables, and will send to the BE a selection payload with the selected rows
 - buttons that work with selection will be rendered only when a selection is made
-- fixes incorrect pages count, fixes incorrect middle pages
+- fixed incorrect pages count, fixed incorrect middle pages
 
 #### tasks
-- adds taskable contract & factory
+- added `taskable` contract & factory
 
 ### private packages
 
 #### webshop
-- adds about-us page
-- adds controller import
-- adds limited stock limit upgrade
-- adds favorites database persistent ref laravel-enso/webshop#33
-- removed restricted mfr load
+- added about-us page
+- added controller import
+- added limited stock limit upgrade
+- added favorites database persistent ref laravel-enso/webshop#33
+- removed restricted/selective mfr load
 
 #### emag
 - fixed file save
-- adds authentication in job
-- adds fetch orders job
-- added FetchOrders command to the service provider so it can be used
+- added authentication in job
+- added fetch orders job
+- added `FetchOrders` command to the service provider
 
 ### Upgrade steps
 
 To upgrade:
-- `app/Http/Controllers/Auth` was removed from enso, if you don't have customization you can remove it too.
-- `teams` was removed from `laravel-enso/core`, you need to add `"laravel-enso/teams": "^3.0",` to composer.json If you need it.
-- `teams` was removed from `enso-ui/ui`, you need to add `"enso-ui/teams": "^2.0",` to package.json If you need it.
+- `app/Http/Controllers/Auth` was removed from enso - if not customized locally, you may remove it as well
+- the `teams` package is no longer included with enso by default. If you require it, add it back:
+    - add `"laravel-enso/teams": "^3.0",` to `composer.json`
+    - add `"enso-ui/teams": "^2.0",` to `client/package.json`
+- update the Enso version to `4.6.0` in `config/enso/config.php`
 - run `composer update` in the project's root
 - run `yarn`, `yarn upgrade && yarn` to ensure you have the latest versions and patches are applied. If necessary, update your patches
-- update the Enso version to 4.6.0 in `config/enso/config.php`
-
+- `php artisan enso:upgrade --before-migration`
+- `php artisan migrate`
+- `php artisan enso:upgrade`
+- as per every release, delete any local, deprecated upgrades
 
 ## 4.5.0