Skip to content

Commit 835e7a7

Browse files
authored
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.
1 parent 0f35016 commit 835e7a7

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
@@ -33,14 +33,14 @@ let app = new EmberApp(defaults, {
3333
});
3434
```
3535

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

3939
```js
4040
let app = new EmberApp(defaults, {
4141
'ember-cli-addon-docs': {
42-
documentingAddonAt: '../addon',
43-
addonSrcFolder: 'source',
42+
documentingAddonAt: '../my-awesome-addon',
43+
addonSrcFolder: 'src',
4444
}
4545
});
4646
```

0 commit comments

Comments
 (0)