Skip to content
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.

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

Document public API on main website #125

Open
mehulkar opened this issue Aug 20, 2019 · 1 comment
Open

Document public API on main website #125

mehulkar opened this issue Aug 20, 2019 · 1 comment

Comments

@mehulkar
Copy link
Contributor

mehulkar commented Aug 20, 2019

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
@mehulkar
Copy link
Contributor Author

These docs also need to do a better job of explaining when to use which hook

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant