Skip to content

Instantly share code, notes, and snippets.

@villander

villander/ember-engines-documentation.md

Forked from dgeb/ember-engines-documentation.md
Created April 4, 2019 03:36
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save villander/62509b085c18680f2b099cbca3d5d406 to your computer and use it in GitHub Desktop.
Save villander/62509b085c18680f2b099cbca3d5d406 to your computer and use it in GitHub Desktop.
Download ZIP
Ember Engines Documentation ToDos
Raw
ember-engines-documentation.md

Ember Engines Documentation ToDos

General

  • Almost all docs from README should be moved to ember-engines.com. Having similar but different info in both places is confusing and unmaintainable.

  • Consider using https://github.com/ember-learn/ember-cli-addon-docs to standardize the docs and guides and to make them version-specific.

  • Clarify the philosophy and intended uses for engines.

  • Update the "Engines Roadmap" section

    • Link to the 1.0 Roadmap

  • Include a section on using engines with Fastboot

  • Testing section is completely blank. We need to discuss what's possible today.

  • Perhaps we should acknowledge issues with the Ember Inspector?

Building Engines

  • Clarify that engines should always be built together with their host app and other engines, regardless of whether they are lazy or eager. This is required for hosts to understand and properly bundle engine dependencies and routes.

  • Explain what will happen when there are dependency mismatches between different engines and/or their host app.

  • Explain the dependency deduping that is currently performed.

  • Explain the manual verification of dependencies that is needed right now.

  • Include a few examples that lists a host app and engines, as well a few dependencies (common and shared) to illustrate points.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment