Docs: Updating docs

Author: jarrodek

README.md

@@ -1,4 +1,4 @@
-**See live example of the API console in our [demo application].**
+__See live example of the API console in our [demo application][].__
 
 # The API Console
 
@@ -28,7 +28,7 @@ New documentation page focuses on presenting the information which is the API an
 
 ### Re-build
 
-New [build tools](build tools) allows you to customize the bundle to your needs and possibly reduce size of the console even more than when using default settings. Check out "Building the console" section for more information.
+New [build tools][] allows you to customize the bundle to your needs and possibly reduce size of the console even more than when using default settings. Check out "Building the console" section for more information.
 
 ## Introduction
 
@@ -58,9 +58,9 @@ $ api-console serve build/ --open
 
 ### Run as a standalone web-application
 
-Recommended way of using API console is to build a standalone application that can be served from your server. Generated sources with `api-console-cli` is production ready bundle of the console ready to be served to your users. The application supports [Deep linking][deep linking], which allows you to share a link to a particular part of your API documentation. You can find a basic example of the standalone application on our [demo application] web page.
+Recommended way of using API console is to build a standalone application that can be served from your server. Generated sources with `api-console-cli` is production ready bundle of the console ready to be served to your users. The application supports [Deep linking][deep linking], which allows you to share a link to a particular part of your API documentation. You can find a basic example of the standalone application on our [demo application][] web page.
 
-To build the API Console as a standalone application use our [build tools].
+To build the API Console as a standalone application use our [build tools][].
 
 ### Using API components
 
@@ -70,7 +70,7 @@ API console is a web component. This mean it can be used in any web environments
 
 This version of the console still works with `bower` as a dependency manager as it works with HTML imports. Next version will work with ES6 module imports which supports npm as a dependency management system.
 
-First, use [Bower] to install the console and its dependencies:
+First, use [Bower][] to install the console and its dependencies:
 
 ```bash
 $ bower install --save mulesoft/api-console
@@ -90,13 +90,13 @@ Finally use the HTML tag:
 </body>
 ```
 
-See complete documentation about how to import sources into your web page in the [api console element docs]. Also, if you are a developer you can check out [demo application source code].
+See complete documentation about how to import sources into your web page in the [api console element docs][]. Also, if you are a developer you can check out [demo application source code][].
 
-You can also build API Console as a embeddable HTML element using one of our [build tools].
+You can also build API Console as a embeddable HTML element using one of our [build tools][].
 
 ## API Console configuration options
 
-Configuration options differ from the previous version. Because API Console is a (custom) HTML element its configuration is based on HTML attributes. You can pass values as an attribute value, or use a boolean option by simply setting the attribute. Configuration from JavaScript code is based on setting a JavaScript property as the attribute name on the element. If the attribute name contains dashes then make the property name [camel case].
+Configuration options differ from the previous version. Because API Console is a (custom) HTML element its configuration is based on HTML attributes. You can pass values as an attribute value, or use a boolean option by simply setting the attribute. Configuration from JavaScript code is based on setting a JavaScript property as the attribute name on the element. If the attribute name contains dashes then make the property name [camel case][].
 
 Example:
 
@@ -112,65 +112,66 @@ console.narrow = true;
 console.appendHeaders = 'x-api-key: 1234';
 ```
 
-See the full list of API Console configuration options in the [configuring the api console] document.
+See the full list of API Console configuration options in the [configuring the api console][] document.
 
 ## Build tools
 
 A set of build tools is included to help you create API Console from the RAML file. Build tools are configured to produce a production optimized version of API Console. The build tools can generate both standalone and embeddable version of the console. You can also configure data source strategy (RAML, JSON or inline JSON as a data source).
 
 The following build tools are available:
 
-* The `api-console` CLI
-* Node modules
-  * `api-console-builder`
+*   The API console CLI
+*   Node modules
+    *   `api-console-builder`
+    *   `amf-client-js`
 
 Depending on your needs you can choose whether you want to use a CLI tool or a node module.
 
-Build tools can be helpful in the CI process to automate the documentation release cycle. See the [build tools] documentation for more information and build strategies.
+Build tools can be helpful in the CI process to automate the documentation release cycle. See the [build tools][] documentation for more information and build strategies.
 
 ## Theming
 API Console supports theming and comes with a default theme. You can create your own theme. For example, you can tweak the style of the console to match your corporate style guide.
 
-Theming is based on CSS variables and CSS mixins. Basic concepts of using the variables and mixins are described in the [Polymer 2.0 styling] documentation. You can check the [api-console-styles.html](api-console-styles.html) file to see the current theme definition, and then read the [theming documentation] to learn how to create your own theme.
+Theming is based on CSS variables and CSS mixins. Basic concepts of using the variables and mixins are described in the [Polymer 2.0 styling][] documentation. You can check the [api-console-styles.html](api-console-styles.html) file to see the current theme definition, and then read the [theming documentation][] to learn how to create your own theme.
 
 ## CORS
 
-Cross-origin resource sharing (CORS) allows sharing resources from one domain to other domains. Browsers block all requests to other domains but with a special set of headers authors can allow other domains to request a resource. For more information, see the [CORS Wiki].
+Cross-origin resource sharing (CORS) allows sharing resources from one domain to other domains. Browsers block all requests to other domains but with a special set of headers authors can allow other domains to request a resource. For more information, see the [CORS Wiki][].
 
 If your API does not allow CORS and you hosting your API documentation in different domain then API Console won't be able to make a request to an endpoint. API Console currently supports 3 ways of dealing with this issue:
 
-- by installing the **API Console Chrome extension**
-- by setting up a **proxy server**
-- by handling HTTP requests from the hosting application
+-   by installing the __API Console Chrome extension__
+-   by setting up a __proxy server__
+-   by handling HTTP requests from the hosting application
 
-Read our [CORS guideline] for more information about each of these solutions.
+Read our [CORS guideline][] for more information about each of these solutions.
 
 ## Preview and development
 
 The API Console is a custom element that serves as a shell element for other custom web components. To develop the API Console most probably you'd have to develop one of over a hundred other web components that creates the console. All the elements are described in [the elements catalog][the elements catalogue].
 
-1. Clone the element.
+1.  Clone the element.
 ```
 git clone https://github.com/mulesoft/api-console.git
 cd api-console
 ```
 
-2. Checkout the latest version.
+2.  Checkout the latest version.
 ```
 git checkout 5.0.0-preview
 ```
 
-3. Install [polymer-cli] and [Bower].
+3.  Install [polymer-cli][] and [Bower][].
 ```
 sudo npm install -g bower polymer-cli
 ```
 
-4. Install dependencies.
+4.  Install dependencies.
 ```
 bower install
 ```
 
-5. Serve the element.
+5.  Serve the element.
 ```
 polymer serve --open
 ```
@@ -187,7 +188,7 @@ See CONTRIBUTING.md for description of how to file issue report of feature reque
 
 ### Contributor's Agreement
 
-To contribute source code to this repository, read our [contributor's agreement](http://www.mulesoft.org/legal/contributor-agreement.html), and then execute it by running this notebook and following these instructions: https://api-notebook.anypoint.mulesoft.com/notebooks/#380297ed0e474010ff43
+To contribute source code to this repository, read our [contributor's agreement](http://www.mulesoft.org/legal/contributor-agreement.html), and then execute it by running this notebook and following these instructions: [api-notebook.anypoint.mulesoft.com/notebooks/#380297ed0e474010ff43](https://api-notebook.anypoint.mulesoft.com/notebooks/#380297ed0e474010ff43)
 
 ## License
 

docs/api-components.md

@@ -5,10 +5,10 @@ This documentation is for advanced use
 API console is a shell application that puts web components together in a
 single application. Three main UI regions of the API console are:
 
-- Navigation (api-navigation)
-- Documentation (api-documentation)
-- Request panel (api-request-panel)
-- Model propagation helper (raml-aware) as an optional dependency.
+-   Navigation (api-navigation)
+-   Documentation (api-documentation)
+-   Request panel (api-request-panel)
+-   Model propagation helper (raml-aware) as an optional dependency.
 
 In some cases you may need to use the components separately to customize the
 experience with your environment. This document describes how to use
@@ -148,10 +148,10 @@ Parts of the logic is optional for API console. Things like OAuth 1 and 2 author
 If you application already support similar logic it's better to use your application's logic and reduce size of the final build.
 This optional dependencies are:
 
-- advanced-rest-client/xhr-simple-request - Uses XHR object to make a request
-- advanced-rest-client/oauth-authorization - Support for OAuth authorization
-- advanced-rest-client/cryptojs-lib - Crypto library that is used by authorization logic
-- advanced-rest-client/web-animations-js - At the time of writing this article Web Animations API is not implemented in any browser and the app uses this API for dropdowns.
+-   advanced-rest-client/xhr-simple-request - Uses XHR object to make a request
+-   advanced-rest-client/oauth-authorization - Support for OAuth authorization
+-   advanced-rest-client/cryptojs-lib - Crypto library that is used by authorization logic
+-   advanced-rest-client/web-animations-js - At the time of writing this article Web Animations API is not implemented in any browser and the app uses this API for dropdowns.
 
 If you having CORS problems or you already support logic for transporting the request handle `api-request` and `api-response` custom events as described in [api-request-editor](https://github.com/advanced-rest-client/api-request-editor/blob/stage/api-request-editor.html#L228) docs.
 

docs/build-tools.md

@@ -5,8 +5,8 @@ API console comes with a set of tools to help you create documentation for your
 **Learn more**
 
 Check out our examples of how to use our build tools in CI pipeline with Travis:
-- [Building API Console for GitHub pages on Travis](gh-pages.md)
-- [Rebuilding the api.json file in the CI process](rebuilding-api-json.md)
+-   [Building API Console for GitHub pages on Travis](gh-pages.md)
+-   [Rebuilding the api.json file in the CI process](rebuilding-api-json.md)
 
 ## CLI
 
@@ -18,14 +18,16 @@ Install the CLI tool globally using `-g` if possible.
 $ sudo npm install -g api-console-cli
 ```
 
+Note, `sudo` is not required on Windows.
+
 If you can't perform the global installation for some reason, then omit `-g` and run the command prefixing `api-console-cli` with `./node_modules/.bin/`.
 
 ### Features
 
-- build - Builds the api console application optimized for production.
-- generate-json - Regenerates the JSON file that can be used as a data source in the console.
+-   build - Builds the api console application optimized for production.
+-   generate-json - Regenerates the JSON file that can be used as a data source in the console.
 
-For more information, see https://github.com/mulesoft-labs/api-console-cli.
+For more information, see [api-console-cli](https://github.com/mulesoft-labs/api-console-cli) page.
 
 ### Examples
 
@@ -35,13 +37,13 @@ Build API Console from the latest released version and use `path/to/api.raml` fi
 $ api-console -t "RAML 1.0" -a path/to/api.raml
 ```
 
-Build API Console from local sources (`--local api-console-release.zip`) that is a zip file of a release.
+Build API Console from local sources (`--local api-console-release.zip`) which is a zip file of a release.
 
 ```shell
 $ api-console build -t "RAML 1.0" --local api-console-release.zip -a path/to/api.raml
 ```
 
-Full documentation: https://github.com/mulesoft-labs/api-console-cli/blob/master/docs/api-console-build.md
+Full documentation: [github.com/mulesoft-labs/api-console-cli/blob/master/docs/api-console-build.md](https://github.com/mulesoft-labs/api-console-cli/blob/master/docs/api-console-build.md)
 
 ## Node
 
@@ -65,7 +67,7 @@ const builder = require('api-console-builder');
 builder({
   api: 'path/to/api.raml',
   apiType: 'RAML 1.0',
-  tagName: '5.0.0-preview',
+  tagName: '5.0.0-preview-1',
   destination: './api-console-bundles'
 })
 .then(() => console.log('Build complete <3'))

docs/configuring-api-console.md

@@ -43,7 +43,7 @@ apic.amfModel = model;
 
 Type: **string**
 
-Uses [raml-aware] element, with `scope` attribute set to the value of this attribute. See [Passing RAML data](passing-raml-data.md) documentation for more information.
+Uses [raml-aware][] element, with `scope` attribute set to the value of this attribute. See [Passing RAML data](passing-raml-data.md) documentation for more information.
 
 ```html
 <raml-aware scope="my-api"></raml-aware>
@@ -60,7 +60,7 @@ aware.raml = model;
 
 Type: **String**
 
-Currently selected object. See section [Controlling the view ](#controlling-the-view) section below for more information.
+Currently selected object. See section [Controlling the view](#controlling-the-view) section below for more information.
 
 ```javascript
 const apic = document.querySelector('api-console');
@@ -75,14 +75,14 @@ Currently selected object type.
 
 It can be one of:
 
-- `summary` - API summary view
-- `documentation` - RAML's documentation node
-- `type` - Model documentation (type, schema)
-- `security` - Security scheme documentation
-- `endpoint` - Endpoint documentation
-- `method` - Method documentation
+-   `summary` - API summary view
+-   `documentation` - RAML's documentation node
+-   `type` - Model documentation (type, schema)
+-   `security` - Security scheme documentation
+-   `endpoint` - Endpoint documentation
+-   `method` - Method documentation
 
-See section [Controlling the view ](#controlling-the-view) section below for more information.
+See section [Controlling the view](#controlling-the-view) section below for more information.
 
 ```javascript
 const apic = document.querySelector('api-console');
@@ -96,7 +96,7 @@ Type: **String**
 Location of the file with gfenerated AMF model to automatically download when this value change.
 This can be used to optimise startup time by not producing AMF model from your API spec each time the console is opened.
 
-The [build tools] allows you to generate this file for you when building production ready console.
+The [build tools][] allows you to generate this file for you when building production ready console.
 
 ```html
 <api-console model-location="static/api/api-model.json"></api-console>
@@ -128,7 +128,7 @@ The request URL is added to the end of the proxy string. Use with combination wi
 
 This sends the request to the proxy service that would look like this:
 
-https://api.service.proxy/?u=https://api.domain.com/endpoint
+`https://api.service.proxy/?u=https://api.domain.com/endpoint`
 
 #### proxy-encode-url
 
@@ -142,7 +142,7 @@ To be used when `proxy` is set. The value appended to the proxy URL is url encod
 
 This sends the request to the proxy service that would look like this:
 
-https://api.service.proxy/?u=https%3A%2F%2Fapi.domain.com%2Fendpoint
+`https://api.service.proxy/?u=https%3A%2F%2Fapi.domain.com%2Fendpoint`
 
 #### manual-navigation
 
@@ -238,7 +238,7 @@ Type: **Boolean**
 
 When set it renders API console as a standalone application.
 Setting this option adds automation like handling media queries and sets mobile friendly styles.
-This attribute is set automatically when using our [build tools].
+This attribute is set automatically when using our [build tools][].
 
 ```html
 <api-console app></api-console>
@@ -397,12 +397,12 @@ The `page` property displays top level pages as documentation or try it screen.
 
 The `selectedShape` property can have the following values:
 
-- `summary` - Summary of the API spec
-- `docs` - Documentation included in the spec
-- `type` - Type
-- `resource` - Endpoint documentation
-- `method` - Method
-- `security` - Security scheme documentation
+-   `summary` - Summary of the API spec
+-   `docs` - Documentation included in the spec
+-   `type` - Type
+-   `resource` - Endpoint documentation
+-   `method` - Method
+-   `security` - Security scheme documentation
 
 Normally API console passes `selectedShape` and `selectedShapeType` values from `api-navigation` to `api-documentation` and `api-request-panel` when navigation occurred. However it can be set programmatically to control the view.
 

docs/cors.md

@@ -43,4 +43,4 @@ The proxy URL won't be visible by the user. The user can't do anything to change
 When the user runs the request from the "try it" screen, API Console fires the `api-request` [custom event](https://developer.mozilla.org/en/docs/Web/API/CustomEvent). If your application can handle the transport (by providing a proxy, for example), listen for this event, and cancel it by calling `event.preventDefault()`. If the event is cancelled, API Console listens for the `api-response` custom
 event that should contain response details. Otherwise, the console uses the build in fallback function to get the resource using Fetch API / XHR.
 
-See https://github.com/advanced-rest-client/api-components-api/blob/master/docs/api-request-and-response.md for detailed documentation of the request events.
+See [github.com/advanced-rest-client/api-components-api/blob/master/docs/api-request-and-response.md](https://github.com/advanced-rest-client/api-components-api/blob/master/docs/api-request-and-response.md) for detailed documentation of the request events.