Fixed broken links in the docs

Author: JamesMessinger

README.md

@@ -86,7 +86,7 @@ $RefParser.dereference(mySchema)
   });
 ```
 
-For more detailed examples, please see the [api documentation](docs/README.md)
+For more detailed examples, please see the [API Documentation](docs/README.md)
 
 
 Installation

docs/README.md

@@ -1,15 +1,25 @@
 JSON Schema $Ref Parser API
 ==========================
 
-### [`$RefParser`](ref-parser.md)
+Things to Know
+---------------------
+- [Class methods vs. Instance methods](#class-methods-vs-instance-methods)
+- [Callbacks vs. Promises](#callbacks-vs-promises)
+- [Circular references](#circular-refs)
+
+
+Classes & Methods
+---------------------
+
+#### [`$RefParser`](ref-parser.md)
 - [`schema`](ref-parser.md#schema)
 - [`$refs`](ref-parser.md#refs)
-- [`dereference()`](ref-parser.md#dereferencepath-options-callback)
-- [`bundle()`](ref-parser.md#bundlepath-options-callback)
-- [`parse()`](ref-parser.md#parsepath-options-callback)
-- [`resolve()`](ref-parser.md#resolvepath-options-callback)
+- [`dereference()`](ref-parser.md#dereferenceschema-options-callback)
+- [`bundle()`](ref-parser.md#bundleschema-options-callback)
+- [`parse()`](ref-parser.md#parseschema-options-callback)
+- [`resolve()`](ref-parser.md#resolveschema-options-callback)
 
-### [`$Refs`](refs.md)
+#### [`$Refs`](refs.md)
 - [`circular`](refs.md#circular)
 - [`paths()`](refs.md#pathstypes)
 - [`values()`](refs.md#valuestypes)
@@ -19,18 +29,11 @@ JSON Schema $Ref Parser API
 - [`get()`](refs.md#getref-options)
 - [`set()`](refs.md#setref-value-options)
 
-### [`YAML`](yaml.md)
+#### [`YAML`](yaml.md)
 - [`parse()`](yaml.md#parsetext)
 - [`stringify()`](yaml.md#stringifyvalue)
 
-### [`Options`](options.md)
-
-
-Topics
----------------------
-- [Class methods vs. Instance methods](#class-methods-vs-instance-methods)
-- [Callbacks vs. Promises](#callbacks-vs-promises)
-- [Circular references](#circular-refs)
+#### [`Options`](options.md)
 
 
 ### Class methods vs. Instance methods
@@ -54,8 +57,7 @@ The difference is that in the second example you now have a reference to `parser
 Many people prefer [ES6 Promise syntax](http://javascriptplayground.com/blog/2015/02/promises/) instead of callbacks.  JSON Schema $Ref Parser allows you to use whichever one you prefer.  Every method accepts an optional callback _and_ returns a Promise.  So pick your poison.
 
 
-Circular $Refs
---------------------------
+### Circular $Refs
 JSON Schema files can contain [circular $ref pointers](https://gist.github.com/BigstickCarpet/d18278935fc73e3a0ee1), and JSON Schema $Ref Parser fully supports them. Circular references can be resolved and dereferenced just like any other reference.  However, if you intend to serialize the dereferenced schema as JSON, then you should be aware that [`JSON.stringify`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify) does not support circular references by default, so you will need to [use a custom replacer function](https://stackoverflow.com/questions/11616630/json-stringify-avoid-typeerror-converting-circular-structure-to-json).
 
 You can disable circular references by setting the [`$refs.circular`](options.md) option to `false`. Then, if a circular reference is found, a `ReferenceError` will be thrown.

docs/ref-parser.md

@@ -8,10 +8,10 @@ This is the default export of JSON Schema $Ref Parser.  You can creates instance
 - [`$refs`](#refs)
 
 ##### Methods
-- [`dereference()`](#dereferencepath-options-callback)
-- [`bundle()`](#bundlepath-options-callback)
-- [`parse()`](#parsepath-options-callback)
-- [`resolve()`](#resolvepath-options-callback)
+- [`dereference()`](#dereferenceschema-options-callback)
+- [`bundle()`](#bundleschema-options-callback)
+- [`parse()`](#parseschema-options-callback)
+- [`resolve()`](#resolveschema-options-callback)
 
 
 ### `Schema`
@@ -65,7 +65,7 @@ See [Callbacks vs. Promises](README.md#callbacks-vs-promises)
 
 Dereferences all `$ref` pointers in the JSON Schema, replacing each reference with its resolved value.  This results in a schema object that does not contain _any_ `$ref` pointers.  Instead, it's a normal JavaScript object tree that can easily be crawled and used just like any other JavaScript object.  This is great for programmatic usage, especially when using tools that don't understand JSON references.
 
-The `dereference` method maintains object reference equality, meaning that all `$ref` pointers that point to the same object will be replaced with references to the same object.  Again, this is great for programmatic usage, but it does introduce the risk of [circular references](README.md#circular-refs), so be careful if you intend to serialize the schema using [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify).  Consider using the [`bundle`](#bundlepath-options-callback) method instead, which does not create circular references.
+The `dereference` method maintains object reference equality, meaning that all `$ref` pointers that point to the same object will be replaced with references to the same object.  Again, this is great for programmatic usage, but it does introduce the risk of [circular references](README.md#circular-refs), so be careful if you intend to serialize the schema using [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify).  Consider using the [`bundle`](#bundleschema-options-callback) method instead, which does not create circular references.
 
 ```javascript
 $RefParser.dereference("my-schema.yaml")
@@ -94,7 +94,7 @@ A callback that will receive the bundled schema object
 - **Return Value:** `Promise`<br>
 See [Callbacks vs. Promises](README.md#callbacks-vs-promises)
 
-Bundles all referenced files/URLs into a single schema that only has _internal_ `$ref` pointers.  This lets you split-up your schema however you want while you're building it, but easily combine all those files together when it's time to package or distribute the schema to other people.  The resulting schema size will be small, since it will still contain _internal_ JSON references rather than being [fully-dereferenced](#dereferencepath-options-callback).
+Bundles all referenced files/URLs into a single schema that only has _internal_ `$ref` pointers.  This lets you split-up your schema however you want while you're building it, but easily combine all those files together when it's time to package or distribute the schema to other people.  The resulting schema size will be small, since it will still contain _internal_ JSON references rather than being [fully-dereferenced](#dereferenceschema-options-callback).
 
 This also eliminates the risk of [circular references](README.md#circular-refs), so the schema can be safely serialized using [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify).
 
@@ -122,7 +122,7 @@ A callback that will receive the parsed schema object, or an error
 - **Return Value:** `Promise`<br>
 See [Callbacks vs. Promises](README.md#callbacks-vs-promises)
 
-> This method is used internally by other methods, such as [`bundle`](#bundlepath-options-callback) and [`dereference`](#dereferencepath-options-callback).  You probably won't need to call this method yourself.
+> This method is used internally by other methods, such as [`bundle`](#bundleschema-options-callback) and [`dereference`](#dereferenceschema-options-callback).  You probably won't need to call this method yourself.
 
 Parses the given JSON Schema file (in JSON or YAML format), and returns it as a JavaScript object.  This method **does not** resolve `$ref` pointers or dereference anything.  It simply parses _one_ file and returns it.