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

Setup complete documentation #19

Open
ravage84 opened this issue May 2, 2017 · 0 comments
Open

Setup complete documentation #19

ravage84 opened this issue May 2, 2017 · 0 comments

Comments

@ravage84
Copy link
Contributor

ravage84 commented May 2, 2017

Especially if this tools becomes bigger and gets more features, it would benefit from having a complete documentation.
This documentation should not live in the README.md, as it would bloat it over time.

Such a documentation could live in an informational website (#17), on an external host such as Read the Docs or simply as a collection of linked Markdown files in the docs folder or a mixture of them (like Composer).

Such a documentation should also document how to extend the current library, if necessary or possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant