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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #28

Open
mydea opened this issue Jan 4, 2018 · 2 comments
Open

Improve documentation #28

mydea opened this issue Jan 4, 2018 · 2 comments
Labels
help wanted

Comments

@mydea
Copy link
Contributor

mydea commented Jan 4, 2018

By now, the README has become quite large.
For the sake of readability, it would probably be a good idea to create an actual documentation app, and deploy it with ember-cli-github-pages.
@mydea
Copy link
Contributor Author

mydea commented Oct 22, 2018

@arm1n what do you think about moving the documentation into the GitHub Wiki? There, we could easily structure the sections into dedicated pages (e.g. setup, the CLI, the service, the helpers, ...).

Alternatively, I would propose to split out the giant README.md into multiple .md files.

@mydea
Copy link
Contributor Author

mydea commented Nov 20, 2018

@arm1n I started to port the super long README into the GitHub Wiki: https://github.com/Cropster/ember-l10n/wiki - Please let me know what you think. This should help to make this more approachable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mydea