Skip to content

Commit

Permalink
Change all shopify.dev theme doc (#472)
Browse files Browse the repository at this point in the history
* [~] Change all links to theme docs

* Update packages/theme-check-common/src/checks/valid-json/index.ts

* Update packages/theme-check-common/src/checks/json-syntax-error/index.ts

---------

Co-authored-by: Guilherme Carreiro <[email protected]>
  • Loading branch information
PolMrt and karreiro authored Aug 22, 2024
1 parent cd63696 commit 01f4a7b
Show file tree
Hide file tree
Showing 41 changed files with 41 additions and 41 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This monorepo is home of all things dev tools for Shopify themes:
- [`@shopify/codemirror-language-client`](./packages/codemirror-language-client) — A CodeMirror Language Client (batteries not included).
- [`theme-check-vscode`](./packages/vscode-extension) — The VS Code extension that uses it all.

These tools are also integrated in the [Online Store Code Editor](https://shopify.dev/docs/themes/tools/code-editor) and the [Shopify CLI](https://shopify.dev/docs/api/shopify-cli/theme).
These tools are also integrated in the [Online Store Code Editor](https://shopify.dev/docs/storefronts/themes/tools/code-editor) and the [Shopify CLI](https://shopify.dev/docs/api/shopify-cli/theme).

They can be used individually or collectively, catering to varied use cases and offering flexibility in their application.

Expand Down
2 changes: 1 addition & 1 deletion packages/codemirror-language-client/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

- 8e3c7e2: Breaking: add `getDefaultSchema{Locale,Translations}(Factory)?` dependencies

To be used to power `MatchingTranslations` for [Schema translations](https://shopify.dev/docs/themes/architecture/locales/schema-locale-files).
To be used to power `MatchingTranslations` for [Schema translations](https://shopify.dev/docs/storefronts/themes/architecture/locales/schema-locale-files).

To be used to power Schema translations code completion and hover in section and theme block `{% schema %}` JSON blobs.

Expand Down
2 changes: 1 addition & 1 deletion packages/codemirror-language-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# CodeMirror Language Client

[CodeMirror](https://codemirror.net/) is the open source library that powers the [Online Store Code Editor](https://shopify.dev/docs/themes/tools/code-editor).
[CodeMirror](https://codemirror.net/) is the open source library that powers the [Online Store Code Editor](https://shopify.dev/docs/storefronts/themes/tools/code-editor).

The [Language Server Protocol](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/) empowers developers to write one language server that can run in all language clients. Write a client, and you gain access to all servers; write one server, and all clients can use it.

Expand Down
2 changes: 1 addition & 1 deletion packages/theme-check-common/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
- 8e3c7e2: Add Schema translation checking to `MatchingTranslations`
- 8e3c7e2: Breaking: add `getDefaultSchema{Locale,Translations}(Factory)?` dependencies

To be used to power `MatchingTranslations` for [Schema translations](https://shopify.dev/docs/themes/architecture/locales/schema-locale-files).
To be used to power `MatchingTranslations` for [Schema translations](https://shopify.dev/docs/storefronts/themes/architecture/locales/schema-locale-files).

To be used to power Schema translations code completion and hover in section and theme block `{% schema %}` JSON blobs.

Expand Down
2 changes: 1 addition & 1 deletion packages/theme-check-common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ yarn add @shopify/theme-check-browser

This repo only contains the library over the functionality. The CLI is implemented in [Shopify/cli](https://github.com/shopify/cli).

For CLI usage documentation, refer to [shopify.dev](https://shopify.dev/docs/themes/tools/theme-check).
For CLI usage documentation, refer to [shopify.dev](https://shopify.dev/docs/storefronts/themes/tools/theme-check).

### Node

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export const AppBlockValidTags: LiquidCheckDefinition = {
docs: {
description:
'Identifies forbidden Liquid tags in theme app extension app block and app embed block code.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/app-block-valid-tags',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/app-block-valid-tags',
recommended: false,
},
type: SourceCodeType.LiquidHtml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export const AssetPreload: LiquidCheckDefinition = {
docs: {
description:
'This check is aimed at discouraging the manual preloading of assets and encourages the use of appropriate Shopify filters.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/asset-preload',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/asset-preload',
recommended: true,
},
type: SourceCodeType.LiquidHtml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export const AssetSizeAppBlockCSS: LiquidCheckDefinition<typeof schema> = {
docs: {
description:
'This check is aimed at preventing large CSS bundles from being included via Theme App Extensions.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/asset-size-app-block-css',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/asset-size-app-block-css',
recommended: true,
},
type: SourceCodeType.LiquidHtml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export const AssetSizeAppBlockJavaScript: LiquidCheckDefinition<typeof schema> =
docs: {
description:
'This check is aimed at preventing large JavaScript bundles from being included via Theme App Extensions.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/asset-size-app-block-javascript',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/asset-size-app-block-javascript',
recommended: true,
},
type: SourceCodeType.LiquidHtml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export const AssetSizeCSS: LiquidCheckDefinition<typeof schema> = {
name: 'Prevent Large CSS bundles',
docs: {
description: 'This check is aimed at preventing large CSS bundles for speed.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/asset-size-css',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/asset-size-css',
recommended: false,
},
type: SourceCodeType.LiquidHtml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export const AssetSizeJavaScript: LiquidCheckDefinition<typeof schema> = {
name: 'Prevent Large JavaScript bundles',
docs: {
description: 'This check is aimed at preventing large JavaScript bundles for speed.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/asset-size-javascript',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/asset-size-javascript',
recommended: false,
},
type: SourceCodeType.LiquidHtml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export const CaptureOnContentForBlock: LiquidCheckDefinition = {
docs: {
description:
'Capture of content_for "block" is restricted to enforce static block rendering at its expected location.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/content_for_block',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/content_for_block',
recommended: true,
},
type: SourceCodeType.LiquidHtml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export const CdnPreconnect: LiquidCheckDefinition = {
docs: {
description: "This check is aimed at signaling the redundant preconnect to Shopify's CDN",
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/cdn-preconnect',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/cdn-preconnect',
},
type: SourceCodeType.LiquidHtml,
severity: Severity.ERROR,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export const ContentForHeaderModification: LiquidCheckDefinition = {
docs: {
description:
'Do not rely on the content of content_for_header as it might change in the future, which could cause your Liquid code behavior to change.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/content-for-header-modification',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/content-for-header-modification',
recommended: true,
},
type: SourceCodeType.LiquidHtml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export const DeprecateBgsizes: LiquidCheckDefinition = {
docs: {
description: 'This check is aimed at discouraging the use of the lazySizes bgset plugin.',
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/deprecate-bgsizes',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/deprecate-bgsizes',
},
type: SourceCodeType.LiquidHtml,
severity: Severity.WARNING,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export const DeprecateLazysizes: LiquidCheckDefinition = {
description:
'This check is aimed at discouraging the use of the lazysizes JavaScript library',
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/deprecate-lazysizes',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/deprecate-lazysizes',
},
type: SourceCodeType.LiquidHtml,
severity: Severity.WARNING,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export const DeprecatedFilter: LiquidCheckDefinition = {
name: 'Deprecated Filter',
docs: {
description: 'Discourages using deprecated filters in themes.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/deprecated-filter',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/deprecated-filter',
recommended: true,
},
type: SourceCodeType.LiquidHtml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export const DeprecatedTag: LiquidCheckDefinition = {
name: 'Deprecated Tag',
docs: {
description: 'This check is aimed at eliminating the use of deprecated tags.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/deprecated-tag',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/deprecated-tag',
recommended: true,
},
type: SourceCodeType.LiquidHtml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export const ImgWidthAndHeight: LiquidCheckDefinition = {
description:
'This check is aimed at eliminating content layout shift in themes by enforcing the use of the width and height attributes on img tags.',
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/img-width-and-height',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/img-width-and-height',
},
type: SourceCodeType.LiquidHtml,
severity: Severity.ERROR,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export const JSONSyntaxError: JSONCheckDefinition = {
docs: {
description: 'This check exists to prevent invalid JSON files in themes.',
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/valid-json',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/json-syntax-error',
},
type: SourceCodeType.JSON,
severity: Severity.ERROR,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export const MatchingTranslations: JSONCheckDefinition = {
docs: {
description: 'TODO',
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/matching-translations',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/matching-translations',
},
type: SourceCodeType.JSON,
severity: Severity.ERROR,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export const MissingAsset: LiquidCheckDefinition = {
docs: {
description: 'Reports missing asset files',
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/missing-asset',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/missing-asset',
},
type: SourceCodeType.LiquidHtml,
severity: Severity.ERROR,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export const MissingTemplate: LiquidCheckDefinition<typeof schema> = {
docs: {
description: 'Reports missing include/render/section liquid file',
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/missing-template',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/missing-template',
},
type: SourceCodeType.LiquidHtml,
severity: Severity.ERROR,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export const PaginationSize: LiquidCheckDefinition<typeof schema> = {
name: 'Ensure paginate tags are used with performant sizes',
docs: {
description: 'This check is aimed at keeping response times low.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/pagination-size',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/pagination-size',
recommended: true,
},
type: SourceCodeType.LiquidHtml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export const ParserBlockingScript: LiquidCheckDefinition = {
docs: {
description: 'They are bad ok?',
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/parser-blocking-javascript',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/parser-blocking-javascript',
},
type: SourceCodeType.LiquidHtml,
severity: Severity.ERROR,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ export const RemoteAsset: LiquidCheckDefinition = {
name: 'Remote Asset',
docs: {
description: 'This check is aimed at eliminating unnecessary HTTP connections.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/remote-asset',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/remote-asset',
recommended: true,
},
type: SourceCodeType.LiquidHtml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export const RequiredLayoutThemeObject: LiquidCheckDefinition = {
description:
'This check prevents missing {{ content_for_header }} and {{ content_for_layout }} objects in layout/theme.liquid.',
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/required-layout-theme-object',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/required-layout-theme-object',
},
type: SourceCodeType.LiquidHtml,
severity: Severity.ERROR,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export const TranslationKeyExists: LiquidCheckDefinition = {
docs: {
description: 'Reports missing translation keys',
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/translation-key-exists',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/translation-key-exists',
},
type: SourceCodeType.LiquidHtml,
severity: Severity.ERROR,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export const UnclosedHTMLElement: LiquidCheckDefinition = {
docs: {
description: 'Warns you of unbalanced HTML tags in branching code',
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/unclosed-html-element',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/unclosed-html-element',
},
type: SourceCodeType.LiquidHtml,
severity: Severity.WARNING,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export const UndefinedObject: LiquidCheckDefinition = {
docs: {
description: 'This check exists to identify references to undefined Liquid objects.',
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/undefined-object',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/undefined-object',
},
type: SourceCodeType.LiquidHtml,
severity: Severity.WARNING,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export const UniqueStaticBlockId: LiquidCheckDefinition = {
docs: {
description:
'This check is aimed at preventing the use of duplicated ids for blocks rendered statically.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/unique-static-block-id',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/unique-static-block-id',
recommended: true,
},
type: SourceCodeType.LiquidHtml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export const UnknownFilter: LiquidCheckDefinition = {
name: 'Prevent use of unknown filters',
docs: {
description: 'This check is aimed at preventing the use of unknown filters.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/unknown-filter',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/unknown-filter',
recommended: true,
},
type: SourceCodeType.LiquidHtml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const UnusedAssign: LiquidCheckDefinition = {
description:
'This check exists to prevent bloat in themes by surfacing variable definitions that are not used.',
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/unused-assign',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/unused-assign',
},
type: SourceCodeType.LiquidHtml,
severity: Severity.WARNING,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export const ValidHTMLTranslation: JSONCheckDefinition = {
name: 'Valid HTML Translation',
docs: {
description: 'This check exists to prevent invalid HTML inside translations.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/valid-html-translation',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/valid-html-translation',
recommended: true,
},
type: SourceCodeType.JSON,
Expand Down
2 changes: 1 addition & 1 deletion packages/theme-check-common/src/checks/valid-json/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export const ValidJSON: JSONCheckDefinition = {
description:
'This check exists to prevent invalid JSON files in themes. Will check against schema if available.',
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/valid-json',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/json-syntax-error',
},
type: SourceCodeType.JSON,
severity: Severity.ERROR,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export const ValidSchema: LiquidCheckDefinition = {
docs: {
description: 'This check is aimed at eliminating JSON errors in schema tags.',
recommended: true,
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/valid-schema',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/valid-schema',
},
type: SourceCodeType.LiquidHtml,
severity: Severity.ERROR,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export const ValidStaticBlockType: LiquidCheckDefinition = {
docs: {
description:
'This check is aimed at preventing the use of an invalid type for blocks rendered statically.',
url: 'https://shopify.dev/docs/themes/tools/theme-check/checks/valid-static-block-type',
url: 'https://shopify.dev/docs/storefronts/themes/tools/theme-check/checks/valid-static-block-type',
recommended: true,
},
type: SourceCodeType.LiquidHtml,
Expand Down
2 changes: 1 addition & 1 deletion packages/theme-check-node/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@

- 8e3c7e2: Breaking: add `getDefaultSchema{Locale,Translations}(Factory)?` dependencies

To be used to power `MatchingTranslations` for [Schema translations](https://shopify.dev/docs/themes/architecture/locales/schema-locale-files).
To be used to power `MatchingTranslations` for [Schema translations](https://shopify.dev/docs/storefronts/themes/architecture/locales/schema-locale-files).

To be used to power Schema translations code completion and hover in section and theme block `{% schema %}` JSON blobs.

Expand Down
2 changes: 1 addition & 1 deletion packages/theme-language-server-common/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
- 8e3c7e2: Add `t:` translation completion and hover support in section and theme block `{% schema %}` tags
- 8e3c7e2: Breaking: add `getDefaultSchema{Locale,Translations}(Factory)?` dependencies

To be used to power `MatchingTranslations` for [Schema translations](https://shopify.dev/docs/themes/architecture/locales/schema-locale-files).
To be used to power `MatchingTranslations` for [Schema translations](https://shopify.dev/docs/storefronts/themes/architecture/locales/schema-locale-files).

To be used to power Schema translations code completion and hover in section and theme block `{% schema %}` JSON blobs.

Expand Down
2 changes: 1 addition & 1 deletion packages/theme-language-server-node/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@
- 8e3c7e2: Make translation completion fuzzy
- 8e3c7e2: Breaking: add `getDefaultSchema{Locale,Translations}(Factory)?` dependencies

To be used to power `MatchingTranslations` for [Schema translations](https://shopify.dev/docs/themes/architecture/locales/schema-locale-files).
To be used to power `MatchingTranslations` for [Schema translations](https://shopify.dev/docs/storefronts/themes/architecture/locales/schema-locale-files).

To be used to power Schema translations code completion and hover in section and theme block `{% schema %}` JSON blobs.

Expand Down
Loading

0 comments on commit 01f4a7b

Please sign in to comment.