Skip to content

Commit a159528

Browse files
nelsonwittwerclaude
andcommitted
Note in fetch-doc description that shopify.dev serves Markdown for every page
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 5e38dc0 commit a159528

3 files changed

Lines changed: 7 additions & 6 deletions

File tree

packages/cli/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1215,7 +1215,7 @@ DESCRIPTION
12151215

12161216
## `shopify fetch-doc [URL]`
12171217

1218-
Download a complete document from shopify.dev, returned as Markdown by default. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. For finding the relevant pieces of content across shopify.dev instead, use `search`.
1218+
Download a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what this tool returns by default. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. For finding the relevant pieces of content across shopify.dev instead, use `search`.
12191219

12201220
```
12211221
USAGE
@@ -1229,9 +1229,10 @@ FLAGS
12291229
text/markdown).
12301230
12311231
DESCRIPTION
1232-
Download a complete document from shopify.dev, returned as Markdown by default. Use this to pull an entire document
1233-
verbatim — for example, a set of instructions an agent follows like a centrally-served skill. For finding the relevant
1234-
pieces of content across shopify.dev instead, use `search`.
1232+
Download a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what this
1233+
tool returns by default. Use this to pull an entire document verbatim — for example, a set of instructions an agent
1234+
follows like a centrally-served skill. For finding the relevant pieces of content across shopify.dev instead, use
1235+
`search`.
12351236
12361237
EXAMPLES
12371238
# fetch the Markdown version of a Shopify.dev page

packages/cli/oclif.manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3544,7 +3544,7 @@
35443544
"required": true
35453545
}
35463546
},
3547-
"description": "Download a complete document from shopify.dev, returned as Markdown by default. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. For finding the relevant pieces of content across shopify.dev instead, use `search`.",
3547+
"description": "Download a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what this tool returns by default. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. For finding the relevant pieces of content across shopify.dev instead, use `search`.",
35483548
"enableJsonFlag": false,
35493549
"examples": [
35503550
"# fetch the Markdown version of a Shopify.dev page\n shopify fetch-doc https://shopify.dev/docs/api/shopify-cli\n\n # fetch the HTML version of a Shopify.dev page\n shopify fetch-doc https://shopify.dev/docs/api/shopify-cli --content-type text/html\n "

packages/cli/src/cli/commands/fetch-doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import {Args, Flags} from '@oclif/core'
44

55
export default class FetchDoc extends Command {
66
static description =
7-
'Download a complete document from shopify.dev, returned as Markdown by default. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. For finding the relevant pieces of content across shopify.dev instead, use `search`.'
7+
'Download a complete document from shopify.dev. Every page on shopify.dev has a Markdown version, and that is what this tool returns by default. Use this to pull an entire document verbatim — for example, a set of instructions an agent follows like a centrally-served skill. For finding the relevant pieces of content across shopify.dev instead, use `search`.'
88

99
static usage = `fetch-doc [URL]`
1010

0 commit comments

Comments
 (0)