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

Documentation #540

Open
MelSumner opened this Issue Apr 11, 2018 · 3 comments

Comments

Projects
None yet
3 participants
@MelSumner
Copy link

MelSumner commented Apr 11, 2018

Expected:
The documentation would be consolidated to one place and when new features are added/updated, they are added to the documentation.

Actual:
Right now, using ember-engines requires a bit of juggling between Github and the guides, which can give the impression that documentation is missing.

Proposed solution:

  1. Make the README.md a table of contents and link to sections on the ember-engines guides/site.
  2. When something new is merged, it can be added to the README (table of contents), even if the author doesn't have time to write the documentation. This will also serve to identify where documentation still needs to be added.
  3. Add a roadmap section to make it visible what the "roadmap to 1.0" looks like
@villander

This comment has been minimized.

Copy link
Contributor

villander commented Dec 26, 2018

@MelSumner can we keep ember-engines site or will to do a new site with Ember Addons Docs?

@mydea

This comment has been minimized.

Copy link
Contributor

mydea commented Jan 3, 2019

I would like to maybe contribute some things to the engines docs, but am unsure about where to go/how to start.

@MelSumner

This comment has been minimized.

Copy link
Author

MelSumner commented Jan 8, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.