Skip to content

Commit 22ead15

Browse files
authored
docs: Wording for v2 addon format (#1667)
* 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. * fix: Link to RFC for v2 addon format isntead of specific blueprint
1 parent 6aacd6a commit 22ead15

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

tests/dummy/app/templates/docs/standalone-apps.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,14 @@ let app = new EmberApp(defaults, {
3535
});
3636
```
3737

38-
If the addon is authored in v2 Addon Format `ember-cli-addon-docs` will look for the addon source code in `src` folder.
38+
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.
3939
You may need to set `addonSrcFolder` config option if addon uses another folder:
4040

4141
```js
4242
let app = new EmberApp(defaults, {
4343
'ember-cli-addon-docs': {
44-
documentingAddonAt: '../addon',
45-
addonSrcFolder: 'source',
44+
documentingAddonAt: '../my-awesome-addon',
45+
addonSrcFolder: 'src',
4646
}
4747
});
4848
```

0 commit comments

Comments
 (0)