docs(api): general formatting and description updates

Author: cuebit

docs/api/model.md

@@ -4,42 +4,49 @@ sidebarDepth: 2
 
 # Model
 
-Vuex ORM Axios adds a few properties and methods to the Model object.
+Vuex ORM Axios adds supporting properties and methods to the `Model` object.
 
 ## Static Properties
 
-### axios
+### `axios`
 
-- **`static axios: AxiosInstance | null`**
+- **Type**: `AxiosInstance | null`
 
-  The axios isntance which was installed during the plugin installation process. Vuex ORM Axios adds a few properties and methods to the Model object. Vuex ORM Axios will use this Axios instance to perform any HTTP request.
+  The axios instance which was either set during plugin installation or set using the [`setAxios`](#setaxios) method. Vuex ORM Axios will use this axios instance to perform requests.
 
-  Usually, this property will not become `null`. However, there's a case where you may need to add Axios instance manually, for example, when using Vuex ORM Axios with Nuxt.js. In that case, this property will temporarily be `null`.
+### `apiConfig`
 
-### globalApiConfig
+- **Type**: `Object`
+- **Default**: `{}`
 
-- **`globalApiConfig: GlobalConfig`**
+  The property that holds the model configuration for requests.
 
-  The property that holds global configuration. The value will be set automatically during the plugin installation process. **Do not mutate this property manually**.
+### `globalApiConfig`
 
-- **`apiConfig: Config | null`**
+- **Type**: `Object`
 
-  The property that defines the Model configuration for the API call.
+  The property that holds the global configuration. The value will be set automatically during the plugin installation process.
+
+::: warning WARNING
+Do not mutate this property programmatically.
+:::
 
 ## Static Methods
 
-### setAxios
+### `api`
+
+- `api(): Request`
 
-- **`static setAxios(axios: AxiosInstance): void`**
+  Return a newly created [Request](request) instance.
 
-  The method to set the Axios instance manually. Usually, you don't have to call this method yourself; however, you might need to use this method to set Axios instance properly in some situations. Please [refer here](../guide/getting-started.html#nuxt-js-integration) for more detail.
+### `setAxios`
 
-### api
+- `setAxios(axios: AxiosInstance): void`
 
-- **`static api(): Request`**
+  Set the axios instance manually. Typical setups will configure the axios instance during installation. However, in some cases (mostly with Nuxt), you may need to set the axios instance at a later stage.
 
-  This method is going to return a new Request instance. A request instance is the wrapper for Axios, and it's used to perform any API request.
+  ::: warning IMPORTANT
+  If you omit the axios instance during installation, it's important that one is set using `setAxios` before any attempt to make an API request.
+  :::
 
-  ```js
-  User.api().get('/api/users')
-  ```
+  **See also**: [Nuxt.js Integration](../guide/setup.md#nuxt-js-integration)

docs/api/request.md

@@ -4,74 +4,82 @@ sidebarDepth: 2
 
 # Request
 
-The Request object is the foundation for the Vuex ORM Axios, and you can call many methods to perform an api request. You can obtain a Request instance by `api` method on the Model.
+The Request object is returned when calling the `api()` method on a model. This object is the foundation for Vuex ORM Axios and enables you to call many of the supported axios methods to perform an API request. Any [Custom Actions](../guide/custom-actions) will also be defined on the Request object.
 
 ```js
 const request = User.api()
 ```
 
-Usually, you could just call Request methods directly by method chaining.
+You can call request methods directly through chaining.
 
 ```js
-User.api().get()
+const response = User.api().get()
 ```
 
 ## Constructor
 
-- **``constructor(model: typeof Model)``**
+- `constructor(model: typeof Model)`
 
-  Request instances require the Model class to be passed to the constructor. It's automatically done when obtaining the Request object through `Model.api()` method. Alternatively,  you could manually construct Request object your self.
+  By default, calling the `api()` method on a model will attach the model class to the Request object.
+
+  You may also create a Request instance by passing a model as the constructors only param.
 
   ```js
-  // This is equivalent to...
-  const request = new Request(User)
+  import { Request } from '@vuex-orm/plugin-axios'
 
-  // This.
-  const request = User.api()
+  const request = new Request(User)
   ```
 
 ## Instance Properties
 
-### model
+### `model`
 
-- **`model: typeof Model`**
+- **Type**: `typeof Model`
 
-  The Model class that is attached to the Request instance.
+  The model class that is attached to the Request instance.
 
-### axios
+### `axios`
 
-- **`axios: AxiosInstance`**
+- **Type**: `AxiosInstance`
 
-  The Axios instance that will be used to perform the request.
+  The axios instance that will be used to perform the request.
 
 ## Instance Methods
 
-### get
+### `get`
+
+- `get(url: string, config: Config = {}): Promise<Response>`
+
+  Performs a `GET` request. It takes the same arguments as the axios `get` method.
+
+### `post`
+
+- `post(url: string, data: any = {}, config: Config = {}): Promise<Response>`
 
-- **`get(url: string, config: Config = {}): Promise<Response>`**
+  Performs a `POST` request. It takes the same arguments as the axios `post` method.
 
-  Performs a `GET` request. It takes the same argument as Axios's `get` method.
+### `put`
 
-### post
+- `put(url: string, data: any = {}, config: Config = {}): Promise<Response>`
 
-- **`post(url: string, data: any = {}, config: Config = {}): Promise<Response>`**
+  Performs a `PUT` request. It takes the same arguments as the axios `put` method.
 
-  Performs a `POST` request. It takes the same argument as Axios's `post` method.
+### `patch`
 
-### put
+- `patch(url: string, data: any = {}, config: Config = {}): Promise<Response>`
 
-- **`put(url: string, data: any = {}, config: Config = {}): Promise<Response>`**
+  Performs a `PATCH` request. It takes the same arguments as the axios `patch` method.
 
-  Performs a `PUT` request. It takes the same argument as Axios's `put` method.
+### `delete`
 
-### patch
+- `delete(url: string, config: Config = {}): Promise<Response>`
 
-- **`patch(url: string, data: any = {}, config: Config = {}): Promise<Response>`**
+  Performs a `DELETE` request. It takes the same arguments as the axios `delete` method.
 
-  Performs a `PATCH` request. It takes the same argument as Axios's `patch` method.
+### `request`
 
-### delete
+- `request(config: Config): Promise<Response>`
 
-- **`delete(url: string, config: Config = {}): Promise<Response>`**
+  Performs a request with the given config options. Requests will default to `GET` if the `method` option is not specified.
 
-  Performs a `DELETE` request. It takes the same argument as Axios's `delete` method.
+  All request aliases call this method by merging the relevant configs. You may use this method if you are more familiar with using the axios API in favour of alias methods.

docs/api/response.md

@@ -4,50 +4,56 @@ sidebarDepth: 2
 
 # Response
 
-The Response object is what gets returned when you make API call via Request object.
+API requests return a Response object. This is responsible for carrying and handling the response body and ultimately executing actions such as persisting data to the store.
 
 ## Instance Properties
 
-### response
+### `response`
 
-- **`response: AxiosResponse`**
+- **Type**: `Object`
 
-  Please refer to the [Axios documentation](https://github.com/axios/axios#response-schema) for more details.
+  The axios response schema. Please refer to the [axios documentation](https://github.com/axios/axios#response-schema) for more details.
 
-### entities
+### `entities`
 
-- **`entities: Collections | null`**
+- **Type**: `Array | null`
 
-  The result of Vuex ORM persistent method.
+  The return value from the Vuex ORM persist method.
 
-### isSaved
+  **See also**: [Configurations - save](../guide/configurations.md#save)
 
-- **`isSaved: boolean`**
+### `isSaved`
 
-  Whether the response data is persisted to the store or not.
+- **Type**: `boolean`
 
-### model
+  Set to `true` when response data has persisted to the store.
 
-- **`model: typeof Model`**
+### `model`
 
-  The Model class that was attached to the Request instance when making an API call.
+- **Type**: `typeof Model`
 
-### config
+  The model class that initially made the request.
 
-- **`config: Config`**
+### `config`
 
-  The configuration which was passed to the Request instance.
+- **Type**: `Object`
+
+  The configuration which was passed to the [Request](request) instance.
 
 ## Instance Methods
 
-### save
+### `save`
 
-- **`save (): Promise<void>`**
+- `save(): Promise<void>`
 
   Save response data to the store.
 
-### delete
+  **See also**: [Deferring Persistence](../guide/usage.md#deferring-persistence)
+
+### `delete`
+
+- `delete(): Promise<void>`
 
-- **`delete (): Promise<void>`**
+  Delete record from the store after a request has completed. This method relies on the `delete` option and will throw an error if it is not set.
 
-  Delete store record depending on `delete` option. If the `delete` option is not specified at the config, it will throw an error.
+  **See also**: [Delete Requests](../guide/usage.md#delete-requests)