Clean up docs

docs/documenting-endpoint-query-parameters.md

@@ -67,7 +67,7 @@ For instance:
 To describe parameters in the URL, use the `@urlParam` annotation. For instance, if you defined your Laravel route like this:
 
 ```php
-Route::get("/post/{id}/{lang?}")
+Route::get("/post/{id}/{lang?}");
 ```
 
 you can use this annotation to describe the `id` and `lang` parameters as shown below. The annotation takes the name of the parameter, an optional "required" label, and then its description. Like with `@queryParams`, a random value will be generated, but you can specify the value to be used in examples and response calls using the `Example: ` syntax.
@@ -85,7 +85,9 @@ public function getPost()
 
 ![](images/endpoint-urlparams-1.png)
 
- If you specify `No-example` for a parameter that's optional (`lang` in our example), Scribe will omit that parameter in requests and response calls.
+```eval_rst
+.. Important:: If you want Scribe to omit an optional parameter (`lang` in our example) in requests and response calls, specify `No-example` for the parameter.
+```
 
 ```php
 /**

docs/index.md

@@ -5,7 +5,8 @@ Generate API documentation for humans from your Laravel/Lumen/[Dingo](https://gi
 
 ```eval_rst
 .. admonition:: Wondering where to get started?
-If you're coming from mpociot/laravel-apidoc-generator, check out `what's new <whats-new.md>`_ and the `migration guide <migrating.md>`_. Otherwise, check out the `Getting Started guide <guide-getting-started.md>`_.
+   
+   If you're coming from mpociot/laravel-apidoc-generator, check out `what's new <whats-new.html>`_ and the `migration guide <migrating.html>`_. Otherwise, check out the `Getting Started guide <guide-getting-started.html>`_.
 ```
 
 ## Contents

docs/migrating.md

@@ -28,7 +28,7 @@ php artisan vendor:publish --provider="Knuckles\Scribe\ScribeServiceProvider" --
 ```
 
 ```eval_rst
-.. Important:: If you've modified the generated Markdown or added prepend/append files, you should copy them to a separate folder (not in `resources/docs`). After generating the new docs, you'll have to manually add your changes in.
+.. Important:: If you've modified the generated Markdown or added prepend/append files, you should copy them to a separate folder (not in :code:`resources/docs`). After generating the new docs, you'll have to manually add your changes in.
 ```
 
 _After you've done all of the above_, delete your `resources/docs/` and `public/docs` folders, to prevent any conflicts with the new ones we'll generate. If you're using `laravel` type output, you can also delete `resources/views/apidoc/`.

docs/whats-new.md

@@ -1,6 +1,6 @@
 # What's new in Scribe
 ```eval_rst
-.. Note:: This page is written for devs coming from mpociot/laravel-apidoc-generator. It should give you an overview of what's new in Scribe, and point you to the relevant documentation on each. Once you're ready to migrate, check out `the migration guide <migrating.html>`_.
+.. Note:: This page is aimed at users coming from mpociot/laravel-apidoc-generator. It should give you an overview of what's new in Scribe, and point you to the relevant documentation on each. Once you're ready to migrate, check out `the migration guide <migrating.html>`_.
 ```
 
 Scribe v1 comews with some new features and tweaks aimed at improving the developer experience and the quality of the output documentation. Let's dive in!