From d0f377a9aafc046be8043ea03ace94d4c70bdded Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Bryx=C3=AD?= Date: Sun, 13 Apr 2025 17:11:59 +0200 Subject: [PATCH 1/2] docs: Wording for v2 addon format - Link to v2 addon format documentation. Not everyone understands what is this about. - Generic `documentingAddonAt` of value `addon` is confusing as it _might_ be "standard" ember folder. Bu using `my-awesome-addon` we hint that this is _user_ generated name. - For `addonSrcFolder` use _the default_ value of `src`. If the user just copy-pastes it, it will just work. --- tests/dummy/app/templates/docs/standalone-apps.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/dummy/app/templates/docs/standalone-apps.md b/tests/dummy/app/templates/docs/standalone-apps.md index 235637fed..d23c33cb4 100644 --- a/tests/dummy/app/templates/docs/standalone-apps.md +++ b/tests/dummy/app/templates/docs/standalone-apps.md @@ -35,14 +35,14 @@ let app = new EmberApp(defaults, { }); ``` -If the addon is authored in v2 Addon Format `ember-cli-addon-docs` will look for the addon source code in `src` folder. +If the addon is authored in [v2 Addon Format](https://github.com/embroider-build/addon-blueprint) `ember-cli-addon-docs` will look for the addon source code in `src` folder. You may need to set `addonSrcFolder` config option if addon uses another folder: ```js let app = new EmberApp(defaults, { 'ember-cli-addon-docs': { - documentingAddonAt: '../addon', - addonSrcFolder: 'source', + documentingAddonAt: '../my-awesome-addon', + addonSrcFolder: 'src', } }); ``` From 35ff0361aa5c56be7a7ec89654c9c8b4d540d141 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Bryxi=CC=81?= Date: Fri, 2 May 2025 18:28:43 +0200 Subject: [PATCH 2/2] fix: Link to RFC for v2 addon format isntead of specific blueprint --- tests/dummy/app/templates/docs/standalone-apps.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/dummy/app/templates/docs/standalone-apps.md b/tests/dummy/app/templates/docs/standalone-apps.md index d23c33cb4..ea0706c33 100644 --- a/tests/dummy/app/templates/docs/standalone-apps.md +++ b/tests/dummy/app/templates/docs/standalone-apps.md @@ -35,7 +35,7 @@ let app = new EmberApp(defaults, { }); ``` -If the addon is authored in [v2 Addon Format](https://github.com/embroider-build/addon-blueprint) `ember-cli-addon-docs` will look for the addon source code in `src` folder. +If the addon is authored in [v2 Addon Format](https://rfcs.emberjs.com/id/0507-embroider-v2-package-format/) `ember-cli-addon-docs` will look for the addon source code in `src` folder. You may need to set `addonSrcFolder` config option if addon uses another folder: ```js