Better Documentation Page

[davidkhierl]

Overview

Dedicated documentation page

Type

• [x] New feature
• [ ] Changes to existing features

Motivation

What inspired this feature request? What problems were you facing?

Good to have nice documentation page for developers

Area

• [ ] Add any relevant Area: <area> labels to this issue

---

Checklist

• [x] I have described this feature request in a way that is actionable (if possible)

[rohanrajpal]

+1, its quite difficult to navigate around Github README's in this repo. If the docs can be shifted to docosaurus/gitbook/shopify docs etc. it would be great!

[mkevinosullivan]

It's unclear what the actual ask is here.

The repo provides a Getting started guide that is linked from the top-level README (https://github.com/Shopify/shopify-api-node/#getting-started)

[davidkhierl]

The README does fine but it could be improved something like Docusaurus or to include it on shopify docs page @rohanrajpal suggested, I find it a bit extra navigating on the readme links

[mkevinosullivan]

We are continually looking to improve the documentation content through the use of repo markdown files in combination with out investment in the https://shopify.dev documentation website. At this time, we're not looking at something like Docusaurus, but we will keep it in consideration as we evolve the content.

Thank you for the suggestion.