Quest: Ember Engines Guides MVP Tracking issue

[villander]

Hello and thanks so much for helping out with the Ember Engines Guides! We need the knowledge you've gained over the years using ember-engines

High level tracking, in progress:

This section is purely for tracking how much work we still have left to do, in a very broad sense.

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. [ issue Documentation ember-engines#540 ]

• Clarify the philosophy and intended uses for engines. [ issue Clarify the philosophy and intended uses for engines #57 ]

  Is the "Why Use Engines?" section on http://ember-engines.com/ sufficient?

• Update the "Engines Roadmap" section [ issue We need clarify roadmap & lazy/eager engines  #56 ]

  Link to the 1.0 Roadmap

• Include a section on using engines with Fastboot. [ issue Include a section on using engines with Fastboot #58 ]

• Testing section is completely blank. We need to discuss what's possible today. [ issue Add Testing section #59 ]

• Make Ember Engines more public for beginners in Ember.js [ issue We need expose the reference to Ember Engines here ember-learn/guides-source#701 ]

• Upgrade documentation with Ember CLI Addon Docs, improving UX [ issue migrate markdown resolver usage to other docs tool #50 ]

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. [ issue We need clarify roadmap & lazy/eager engines  #56 ]

• Explain what will happen when there are dependency mismatches between different engines and/or their host app. [ issue Add section about dependency mismatches #60 ]

• Explain the dependency deduping that is currently performed. [ issue Improve documentation on engine-addon development workflow #16 ]

• Explain the manual verification of dependencies that is needed right now. [ issue Expose dependency checking #61 ]

• Include a few examples that lists a host app and engines, as well a few dependencies (common and shared) to illustrate points. [ issue Add more real use cases with host app & engines  #62 ]

[lifeart]

Engines example repo - https://github.com/catz/eng-test

[villander]

thanks @lifeart I'll do a awesome demo with this work, adding more UI/UX.

[abhilashlr]

Also an architecture diagram on how engines work?

[villander]

Also an architecture diagram on how engines work?

this will be expose on #62, it already tracked on this issue. We need of great examples with ember-engines to clarify the purpose and how it works