Linting docs

Author: mkevinosullivan

CONTRIBUTING.md

@@ -9,15 +9,15 @@ We welcome your contributions to the project. There are a few steps to take when
 - Update the docs for any API changes.
 - Submit a pull request.
 
-# Bug Reporting
+## Bug Reporting
 
 Shopify App Express package for Node uses GitHub issue tracking to manage bugs, please open an issue there.
 
-# Feature Request
+## Feature Request
 
 You can open a new issue on the GitHub issues and describe the feature you would like to see.
 
-# Developing the package
+## Developing the package
 
 Requirements:
 
@@ -26,7 +26,7 @@ Requirements:
 
 You can set up your development environment by running the following:
 
-```
+```shell
 git clone [email protected]:Shopify/shopify-app-js.git # get the code
 cd shopify-app-js                                   # change into the source directory
 yarn install                                        # install dependencies

README.md

@@ -1,5 +1,9 @@
 # `@shopify/shopify-app-js`
 
-This repo is a collection of packages makes it easy for [Express.js](https://expressjs.com/) apps to integrate with Shopify.  The main package is `@shopify/shopify-app-express`, which builds on the `@shopify/shopify-api` package and creates a middleware layer that allows the app to communicate with and authenticate requests from Shopify.  Also included are a variety of `SessionStorage` packages for different storage mechanisms that are compatible with the Express package for storing sessions.
+This repo is a collection of packages makes it easy for [Express.js](https://expressjs.com/) apps to integrate with Shopify.
+
+The main package is `@shopify/shopify-app-express`, which builds on the `@shopify/shopify-api` package and creates a middleware layer that allows the app to communicate with and authenticate requests from Shopify.
+
+This repo also contains a variety of `SessionStorage` packages for different storage mechanisms that are compatible with the Express package for storing sessions.
 
 See the respective `README.md` files in the [packages](packages) sub-directories for more details.

RELEASING.md

@@ -2,11 +2,12 @@
 
 1. The `shopify-app-js` repo uses `changesets` to track and update the respective `CHANGELOG.md` files within the packages.
 
-1. When creating a PR, the author should run the `yarn changeset` command, answer the relevant questions (i.e., what packages does this PR update, is it major/minor/patch, what is the change description), and then commit the new file created in the `.changeset` directory.  These files are used by the workflows to construct the `CHANGELOG.md` entries.
+1. When creating a PR, the author should run the `yarn changeset` command, answer the relevant questions (i.e., what packages does this PR update, is it major/minor/patch, what is the change description), and then commit the new file created in the `.changeset` directory. These files are used by the workflows to construct the `CHANGELOG.md` entries.
 
-> Note: If the change is very small and doesn't warrant a changelog entry, run `yarn changeset --empty` and commit the resultant file in the `.changeset` directory.
+   > **Note**
+   > If the change is very small and doesn't warrant a changelog entry, run `yarn changeset --empty` and commit the resultant file in the `.changeset` directory.
 
-1. When the PR is merged into the `main` branch, the `main-release.yml` workflow uses the `changesets/action` to either create or update an existing PR that has the title `Version Packages`.  This PR tracks all the changes currently being made against the `main` branch since the last release.
+1. When the PR is merged into the `main` branch, the `main-release.yml` workflow uses the `changesets/action` to either create or update an existing PR that has the title `Version Packages`. This PR tracks all the changes currently being made against the `main` branch since the last release.
 
 1. To perform a release, check the details of the `Version Packages` PR, and merge it into `main`.
 
@@ -16,13 +17,15 @@
 
 For significant changes that could result in significant refactoring on the part of developers, consider releasing a few _Release Candidate_ versions in advance of the final version.
 
-> Note: These changes **must** be made against the `next` branch, so that the appropriate workflows can run (`next-release.yml`).
+> **Note**
+> These changes **must** be made against the `next` branch, so that the appropriate workflows can run (`next-release.yml`).
 
-1. Prior to creating PR, run the `yarn changeset pre enter rc` command and commit the resultant files from `.changeset`, including the `pre.json` file.  This informs `changesets` that it is in pre-release mode, and the pre-release tag is `rc`.
+1. Prior to creating PR, run the `yarn changeset pre enter rc` command and commit the resultant files from `.changeset`, including the `pre.json` file. This informs `changesets` that it is in pre-release mode, and the pre-release tag is `rc`.
 
-1. When creating a PR, the author should run the `yarn changeset` command, answer the relevant questions (i.e., what packages does this PR update, is it major/minor/patch, what is the change description), and then commit the new file created in the `.changeset` directory.  These files are used by the workflows to construct the `CHANGELOG.md` entries for the release candidates.
+1. When creating a PR, the author should run the `yarn changeset` command, answer the relevant questions (i.e., what packages does this PR update, is it major/minor/patch, what is the change description), and then commit the new file created in the `.changeset` directory. These files are used by the workflows to construct the `CHANGELOG.md` entries for the release candidates.
 
-> Note: If the change is very small and doesn't warrant a changelog entry, run `yarn changeset --empty` and commit the resultant file in the `.changeset` directory.
+   > **Note**
+   > If the change is very small and doesn't warrant a changelog entry, run `yarn changeset --empty` and commit the resultant file in the `.changeset` directory.
 
 1. When the PR is merged into the `next` branch, the `next-release.yml` workflow uses the `changesets/action` to either create or update an existing PR that has the title `Version Packages for Release Candidates`.
 
@@ -34,17 +37,18 @@ For significant changes that could result in significant refactoring on the part
 
 When a major set of changes is about to be mass released from the `next` branch
 
-1. Take the `next` branch out of pre-release mode by running
+> **Warning**
+> The next steps need to be confirmed
 
-```shell
-yarn changeset pre exit
-```
+1. Take the `next` branch out of pre-release mode by running
 
-And commit the changed files.
+   ```shell
+   yarn changeset pre exit
+   ```
 
-> Warning: the next steps need to be confirmed
+   And commit the changed files.
 
-1. Merge the `next` branch into `main`.  This _should_ update the relevant `CHANGELOG.md` files on `main` with the changes from the release candidates.
+1. Merge the `next` branch into `main`. This _should_ update the relevant `CHANGELOG.md` files on `main` with the changes from the release candidates.
 
 1. In the resultant `Version Packages` PR, edit the `CHANGELOG.md` files as needed, as many of the entries may be irrelevant (early release candidate comments no longer applicable) or may be combined.