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

Add example output to documentation #1

Open
madthanu opened this issue Mar 27, 2015 · 0 comments
Open

Add example output to documentation #1

madthanu opened this issue Mar 27, 2015 · 0 comments

Comments

@madthanu
Copy link
Owner

Problem: The current documentation describes the output of the alice-check tool, in a paragraph. However, many users end up getting an Exception (or other kinds of errors) when they run alice-check for the first time, and get confused whether this is the correct output of alice-check.

Suggested solution: Users (phoeagon mainly) suggest adding a screenshot of the alice-check output to the documentation. It is also a good idea to attach a screenshot of alice-check running into an error.

@madthanu madthanu changed the title Add example output to documentation Add documentation Apr 5, 2015
@madthanu madthanu changed the title Add documentation Add example output to documentation Apr 5, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant