From f6c13d1b6d4128bf6de82cefde865322c9b4eb7b Mon Sep 17 00:00:00 2001 From: "Graham F. Scott" Date: Mon, 15 Mar 2021 10:29:05 -0400 Subject: [PATCH 1/3] Rename index.md to README.md Since the primary context for consuming this content is directly in GitHub, if we change this filename to README.md, it will display the page content when browsing this directory. --- docs/{index.md => README.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{index.md => README.md} (100%) diff --git a/docs/index.md b/docs/README.md similarity index 100% rename from docs/index.md rename to docs/README.md From a4ac147634384675394c3b12dd74c9187b91b9ab Mon Sep 17 00:00:00 2001 From: "Graham F. Scott" Date: Mon, 15 Mar 2021 10:59:21 -0400 Subject: [PATCH 2/3] update links --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7a7fdacf9..7e396624f 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,10 @@ To follow these usage guides, you will need to: - add the `ngrok` URL and the appropriate redirect for your OAuth callback route to your app settings - have [yarn](https://yarnpkg.com) installed - + # Getting started -You can follow our [getting started guide](docs/index.md), which will provide instructions on how to create an app using plain Node.js code, or the [Express](https://expressjs.com/) framework. Both examples are written in Typescript. +You can follow our [getting started guide](docs/), which will provide instructions on how to create an app using plain Node.js code, or the [Express](https://expressjs.com/) framework. Both examples are written in Typescript. - [Getting started](docs/getting_started.md) - [Install dependencies](docs/getting_started.md#install-dependencies) From bc665b58c320c5ca6b7cb6ed4448c3b6d9e2f15b Mon Sep 17 00:00:00 2001 From: "Graham F. Scott" Date: Mon, 15 Mar 2021 11:02:33 -0400 Subject: [PATCH 3/3] changelog entry --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 58970e0f7..3f7ae5b86 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,7 @@ and adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). ### Fixed - Throw a different error for a missing cookie upon OAuth return [#131](https://github.com/shopify/shopify-node-api/pull/131) - Improved documentation for GraphQL and Rest Clients. [#123](https://github.com/Shopify/shopify-node-api/pull/123) +- Made Docs directory more browseable in GitHub. [#136](https://github.com/Shopify/shopify-node-api/pull/136) ### Fixed