ember-learn / ember-learn/cli-guides

Document public API on main website

Open
#125 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
26
Forks
77
Avg merge
9m
Merged PRs (30d)
2

Description

Add the API reference here: https://cli.emberjs.com/release/api-documentation/

There's probably some infrastructure work to make this happen automatically, but I think we can start by manually documenting the methods available to an addon in `index.js`? I don't think the methods change very often. Here's the list (taken from https://ember-cli.com/api/classes/Addon.html):

- config
- blueprintsPath
- includedCommands
- importTransforms
- serverMiddleware
- testemMiddleware
- postBuild
- preBuild
- outputReady
- buildError
- included
- shouldIncludeChildAddon
- setupPreprocessorRegistry
- preprocessTree
- postprocessTree
- lintTree
- contentFor
- treeFor

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.