docs: move usage to top of every file

Author: eddyerburgh

docs/en/README.md

@@ -1,8 +1,8 @@
-# vue-test-utils
+# Vue Test Utils
 
-vue-test-utils is the official test library for Vue.js. 
+Vue Test Utils is the official test library for Vue.js. 
 
-It provides methods for unit testing Vue components.
+It provides methods for [unit testing](guides/introduction-to-unit-tests.md) Vue components.
 
 ## Example
 
@@ -18,9 +18,9 @@ expect(wrapper.text()).toContain('1')
 
 ## Getting started
 
-To get started using Vue Test Utils, please see [using with jest]().
+To get started using Vue Test Utils, please see [using with jest](guides/using-with-jest.md).
 
-If you're new to unit testing, please read our [introduction to unit tests]().
+If you're new to unit testing, you can read our [introduction to unit tests](guides/introduction-to-unit-tests.md).
 
 ## Testing single file components (SFCs)
 

docs/en/api/README.md

@@ -1,3 +1,7 @@
-## [mount](/docs/en/api/mount.md)
-## [shallow](/docs/en/api/shallow.md)
-## [selectors](/docs/en/api/selectors.md)
+# API
+
+## [mount](api/mount.md)
+## [shallow](shallow.md)
+## [options](options.md)
+## [createLocalVue](createLocalVue.md)
+## [selectors](selectors.md)

docs/en/api/createLocalVue.md

@@ -25,4 +25,4 @@ const freshWrapper = shallow(Foo)
 expect(freshWrapper.vm.foo).to.equal(false)
 ```
 
-- **See also:** [Common Gotchas](/en/common-gotchas.md)
+- **See also:** [Common Gotchas](common-gotchas.md)

docs/en/api/mount.md

@@ -9,13 +9,13 @@
 
 - **Options:**
 
-See [options](/docs/en/api/options.md)
+See [options](options.md)
 
 - **Usage:**
 
-Returns [`Wrapper`](/docs/en/api/wrapper/README.md) of first DOM node or Vue component matching selector.
+Returns [`Wrapper`](wrapper/README.md) of first DOM node or Vue component matching selector.
 
-Use any valid [selector](/docs/en/api/selectors.md).
+Use any valid [selector](selectors.md).
 
 **Without options:**
 
@@ -133,4 +133,4 @@ describe('Foo', () => {
 })
 ```
 
-- **See also:** [Wrapper](/docs/en/api/wrapper/README.md)
+- **See also:** [Wrapper](wrapper/README.md)

docs/en/api/options.md

@@ -22,7 +22,7 @@ Vue options are passed to the component when a new instance is created. , e.g. `
 
 `options` (`Object`): a Vue options object. Vue options are passed to the component when a new instance is created. , e.g. `store`, `propsData`. For full list, see the [Vue API](https://vuejs.org/v2/api/). Also takes vue-test-utils options:
 
-`options.attachToDocument` (`boolean`): Component will attach to DOM when rendered. This can be used with [`hasStyle`](/docs/en/api/wrapper/hasStyle.md) to check multi element CSS selectors
+`options.attachToDocument` (`boolean`): Component will attach to DOM when rendered. This can be used with [`hasStyle`](wrapper/hasStyle.md) to check multi element CSS selectors
 
 `options.attrs` (`Object`): Attrs object to pass to component.
 
@@ -34,7 +34,7 @@ Vue options are passed to the component when a new instance is created. , e.g. `
 
 `options.intercept` (`Object`): Add globals to Vue instance.
 
-`options.localVue` (`Object`): vue class to use in `mount`. See [createLocalVue](/docs/en/api/createLocalVue.md)
+`options.localVue` (`Object`): vue class to use in `mount`. See [createLocalVue](createLocalVue.md)
 
 `options.propsData` (`Object`): Data for props in component
 

docs/en/api/wrapper-array/README.md

@@ -1,6 +1,6 @@
 # WrapperArray
 
-A `WrapperArray` is an object that contains an array of [Wrappers](/docs/en/api/wrapper/README.md), and methods to test the `Wrappers`.
+A `WrapperArray` is an object that contains an array of [Wrappers](../wrapper/README.md), and methods to test the `Wrappers`.
 
 - **Properties:**
 

docs/en/api/wrapper-array/at.md

@@ -1,13 +1,15 @@
 # at(index)
 
+- **Usage:**
+
+Returns `Wrapper` at `index` passed. Uses zero based numbering (i.e. first item is at index 0).
+
 - **Arguments:**
   - `{number} index`
 
 - **Returns:** `{Wrapper}`
 
-- **Usage:**
-
-Returns `Wrapper` at `index` passed. Uses zero based numbering (i.e. first item is at index 0).
+- **Example:**
 
 ```js
 import { shallow } from 'vue-test-utils'

docs/en/api/wrapper-array/contains.md

@@ -1,15 +1,17 @@
 # contains(selector)
 
+- **Usage:**
+
+Assert every wrapper in `WrapperArray` contains selector. 
+
+Use any valid [selector](../selectors.md).
+
 - **Arguments:**
   - `{string|Component} selector`
 
 - **Returns:** `{boolean}`
 
-- **Usage:**
-
-Assert every wrapper in `WrapperArray` contains selector. 
-
-Use any valid [selector](/docs/en/api/selectors.md).
+- **Example:**
 
 ```js
 import { shallow } from 'vue-test-utils'

docs/en/api/wrapper-array/hasAttribute.md

@@ -1,14 +1,16 @@
 # hasAttribute(attribute, value)
 
+- **Usage:**
+
+Assert every `Wrapper` in `WrapperArray` DOM node has `attribute` matching `value`. 
+
 - **Arguments:**
   - `{string} attribute`
   - `{string} value`
 
 - **Returns:** `{boolean}`
 
-- **Usage:**
-
-Assert every `Wrapper` in `WrapperArray` DOM node has `attribute` matching `value`. 
+- **Example:**
 
 ```js
 import { mount } from 'vue-test-utils'

docs/en/api/wrapper-array/hasClass.md

@@ -1,13 +1,15 @@
 # hasClass(className)
 
+- **Usage:**
+
+Assert every `Wrapper` in `WrapperArray` DOM node has class containing `className`. 
+
 - **Arguments:**
   - `{string} className`
 
 - **Returns:** `{boolean}`
 
-- **Usage:**
-
-Assert every `Wrapper` in `WrapperArray` DOM node has class containing `className`. 
+- **Example:**
 
 ```js
 import { mount } from 'vue-test-utils'

docs/en/api/wrapper-array/hasProp.md

@@ -1,22 +1,18 @@
 # hasProp(prop, value)
 
-Check if every wrapper vm in wrapper array has prop matching value 
+- **Usage:**
 
-Can only be called on a Vue instance.
+Assert every `Wrapper` in `WrapperArray`  `vm` has `prop` matching `value`.
 
-# hasProp(prop, value)
+**Note the Wrapper must contain a Vue instance.**
 
 - **Arguments:**
   - `{string} prop`
   - `{any} value`
 
 - **Returns:** `{boolean}`
 
-- **Usage:**
-
-Assert every `Wrapper` in `WrapperArray`  `vm` has `prop` matching `value`.
-
-**Note the Wrapper must contain a Vue instance.**
+- **Example:**
 
 ```js
 import { mount } from 'vue-test-utils'

docs/en/api/wrapper-array/hasStyle.md

@@ -1,18 +1,19 @@
 # hasStyle(style, value)
 
-- **Arguments:**
-  - `{string} style`
-  - `{string} value`
-
-- **Returns:** `{boolean}`
-
 - **Usage:**
 
 Assert every `Wrapper` in `WrapperArray` DOM node has style matching value.
 
 Returns `true` if `Wrapper` DOM node has `style` matching `string`.
 
 **Note will only detect inline styles when running in `jsdom`.**
+- **Arguments:**
+  - `{string} style`
+  - `{string} value`
+
+- **Returns:** `{boolean}`
+
+- **Example:**
 
 ```js
 import { mount } from 'vue-test-utils'

docs/en/api/wrapper-array/is.md

@@ -1,13 +1,15 @@
 # is(selector)
 
+- **Usage:**
+
+Assert every `Wrapper` in `WrapperArray` DOM node or `vm` matches [selector](../selectors.md).
+
 - **Arguments:**
   - `{string|Component} selector`
 
 - **Returns:** `{boolean}`
 
-- **Usage:**
-
-Assert every `Wrapper` in `WrapperArray` DOM node or `vm` matches [selector](/docs/en/api/selectors.md).
+- **Example:**
 
 ```js
 import { mount } from 'vue-test-utils'

docs/en/api/wrapper-array/isEmpty.md

@@ -1,11 +1,13 @@
 # isEmpty()
 
-- **Returns:** `{boolean}`
-
 - **Usage:**
 
 Assert every `Wrapper` in `WrapperArray` does not contain child node.
 
+- **Returns:** `{boolean}`
+
+- **Example:**
+
 ```js
 import { mount } from 'vue-test-utils'
 import { expect } from 'chai'

docs/en/api/wrapper-array/isVueInstance.md

@@ -1,11 +1,13 @@
 # isVueInstance()
 
-- **Returns:** `{boolean}`
-
 - **Usage:**
 
 Assert every `Wrapper` in `WrapperArray` is Vue instance.
 
+- **Returns:** `{boolean}`
+
+- **Example:**
+
 ```js
 import { mount } from 'vue-test-utils'
 import { expect } from 'chai'

docs/en/api/wrapper-array/setData.md

@@ -1,14 +1,16 @@
 # setData(data)
 
-- **Arguments:**
-  - `{Object} data`
-
 - **Usage:**
 
 Sets `Wrapper` `vm` data and forces update on each `Wrapper` in `WrapperArray`.
 
 **Note every `Wrapper` must contain a Vue instance.**
 
+- **Arguments:**
+  - `{Object} data`
+
+- **Example:**
+
 ```js
 import { mount } from 'vue-test-utils'
 import { expect } from 'chai'

docs/en/api/wrapper-array/setMethods.md

@@ -1,15 +1,17 @@
 
 # setMethods(methods)
 
-- **Arguments:**
-  - `{Object} methods`
-
 - **Usage:**
 
 Sets `Wrapper` `vm` methods and forces update on each `Wrapper` in `WrapperArray`.
 
 **Note every `Wrapper` must contain a Vue instance.**
 
+- **Arguments:**
+  - `{Object} methods`
+
+- **Example:**
+
 ```js
 import { mount } from 'vue-test-utils'
 import { expect } from 'chai'

docs/en/api/wrapper-array/setProps.md

@@ -1,14 +1,16 @@
 # setProps(props)
 
-- **Arguments:**
-  - `{Object} props`
-
 - **Usage:**
 
 Sets `Wrapper` `vm` props and forces update on each `Wrapper` in `WrapperArray`.
 
 **Note every `Wrapper` must contain a Vue instance.**
 
+- **Arguments:**
+  - `{Object} props`
+
+- **Example:**
+
 ```js
 import { mount } from 'vue-test-utils'
 import { expect } from 'chai'

docs/en/api/wrapper-array/trigger.md

@@ -1,14 +1,16 @@
 # trigger(eventName)
 
-- **Arguments:**
-  - `{string} eventName
-
 - **Usage:**
 
 Triggers an event on every `Wrapper` in the `WrapperArray` DOM node.
 
 **Note every `Wrapper` must contain a Vue instance.**
 
+- **Arguments:**
+  - `{string} eventName`
+
+- **Example:**
+
 ```js
 import { mount } from 'vue-test-utils'
 import { expect } from 'chai'

docs/en/api/wrapper-array/update.md

@@ -6,7 +6,7 @@ Force root Vue component of each `Wrapper` in `WrapperArray` to re-render.
 
 If called on a Vue component wrapper array, it will force each Vue component to re-render.
 
-### Example
+- **Example:**
 
 ```js
 import { mount } from 'vue-test-utils'

docs/en/api/wrapper/contains.md

@@ -1,13 +1,15 @@
 # contains(selector)
 
+- **Usage:**
+
+Assert `Wrapper` contains an element or component matching [selector](../selectors.md).
+
 - **Arguments:**
   - `{string|Component} selector`
 
 - **Returns:** `{boolean}`
 
-- **Usage:**
-
-Assert `Wrapper` contains an element or component matching [selector](/docs/en/api/selectors.md).
+- **Example:**
 
 ```js
 import { mount } from 'vue-test-utils'
@@ -20,4 +22,4 @@ expect(wrapper.contains('p')).to.equal(true)
 expect(wrapper.contains(Bar)).to.equal(true)
 ```
 
-- **See also:** [selectors](/docs/en/api/selectors.md)
+- **See also:** [selectors](../selectors.md)