From dcf5282c6a22d3321e428a1ed007420864f0a7d2 Mon Sep 17 00:00:00 2001 From: Chris Manson Date: Tue, 9 May 2023 15:44:40 +0100 Subject: [PATCH] fix casing in docs links --- docs/addon-author-guide.md | 2 +- docs/{UPGRADE-GUIDES.md => upgrade-guides.md} | 0 packages/addon-dev/README.md | 2 +- packages/util/README.md | 2 +- packages/util/addon/index.js | 2 +- 5 files changed, 4 insertions(+), 4 deletions(-) rename docs/{UPGRADE-GUIDES.md => upgrade-guides.md} (100%) diff --git a/docs/addon-author-guide.md b/docs/addon-author-guide.md index 1a6772e81..eb3911241 100644 --- a/docs/addon-author-guide.md +++ b/docs/addon-author-guide.md @@ -74,4 +74,4 @@ We support some tools to make V2 addon development more convenient: ## Replacing the {{component}} helper -This section grew into its own separate document. +This section grew into its [own separate document](./replacing-component-helper.md). diff --git a/docs/UPGRADE-GUIDES.md b/docs/upgrade-guides.md similarity index 100% rename from docs/UPGRADE-GUIDES.md rename to docs/upgrade-guides.md diff --git a/packages/addon-dev/README.md b/packages/addon-dev/README.md index 31a85d1cd..e1aa7bc62 100644 --- a/packages/addon-dev/README.md +++ b/packages/addon-dev/README.md @@ -2,7 +2,7 @@ Utilities for working on v2 addons. -For a guide on porting a V1 addon to V2, see https://github.com/embroider-build/embroider/blob/main/PORTING-ADDONS-TO-V2.md +For a guide on porting a V1 addon to V2, see https://github.com/embroider-build/embroider/blob/main/docs/porting-addons-to-v2.md ## Rollup Utilities diff --git a/packages/util/README.md b/packages/util/README.md index 66e121eff..80ce5e593 100644 --- a/packages/util/README.md +++ b/packages/util/README.md @@ -20,7 +20,7 @@ ember install @embroider/util **This function is intended to help addon authors who still need to support Ember < 3.25**. In all other cases, instead of using this you should directly pass components around as values (not as strings) and invoke them directly with angle brackets (not the `{{component}}` helper). -For the full explanation of why and how you would use this, see [the Addon Author Guide](https://github.com/embroider-build/embroider/blob/main/REPLACING-COMPONENT-HELPER.md). +For the full explanation of why and how you would use this, see [the Addon Author Guide](https://github.com/embroider-build/embroider/blob/main/docs/replacing-component-helper.md). Example usage in Javascript: diff --git a/packages/util/addon/index.js b/packages/util/addon/index.js index d06dc6c70..ee045ba23 100644 --- a/packages/util/addon/index.js +++ b/packages/util/addon/index.js @@ -31,7 +31,7 @@ function handleString(name, thingWithOwner) { false, { id: 'ensure-safe-component.string', - url: 'https://github.com/embroider-build/embroider/blob/main/REPLACING-COMPONENT-HELPER.md#when-youre-passing-a-component-to-someone-else', + url: 'https://github.com/embroider-build/embroider/blob/main/docs/replacing-component-helper.md#when-youre-passing-a-component-to-someone-else', until: 'embroider', for: '@embroider/util', since: '0.27.0',