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

Move documentation from e-c-addon-docs to field-guide #359

Closed
elwayman02 opened this issue May 19, 2021 · 3 comments
Closed

Move documentation from e-c-addon-docs to field-guide #359

elwayman02 opened this issue May 19, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@elwayman02
Copy link
Owner

elwayman02 commented May 19, 2021

e-c-addon-docs is more or less unmaintained, so let's move our docs to the future and use field-guide instead. Here's an example of a similar addon that uses field-guide:

https://github.com/elwayman02/ember-resize-modifier/tree/master/docs

Setup should be fairly simple - Copy the markdown files from e-c-addon-docs to the location field-guide expects them to be and delete any e-c-addon-docs code from the demo app.

@elwayman02 elwayman02 added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels May 19, 2021
@garrettwelson
Copy link

Hello! I'm definitely interested in taking this on. I've used the addon a fair amount and love working with it

@elwayman02
Copy link
Owner Author

One interesting part of this project will be migrating the living demo. Thankfully, the example I linked above shows how field-guide supports creating component classes to back the demo code in the markdown files. You can find that file here: https://github.com/elwayman02/ember-resize-modifier/blob/master/docs/modifiers/did-resize.js

@elwayman02
Copy link
Owner Author

Fixed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants