Skip to content

docs: Wording for v2 addon format #1667

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 2, 2025
Merged

docs: Wording for v2 addon format #1667

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0f377a
docs: Wording for v2 addon format
MichalBryxi Apr 13, 2025
35ff036
fix: Link to RFC for v2 addon format isntead of specific blueprint
MichalBryxi May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions tests/dummy/app/templates/docs/standalone-apps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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://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
let app = new EmberApp(defaults, {
'ember-cli-addon-docs': {
documentingAddonAt: '../addon',
addonSrcFolder: 'source',
documentingAddonAt: '../my-awesome-addon',
addonSrcFolder: 'src',
}
});
```
Expand Down