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

Make docs simpler #3

Open
hadisfr opened this issue Oct 30, 2018 · 2 comments
Open

Make docs simpler #3

hadisfr opened this issue Oct 30, 2018 · 2 comments
Labels
docs Related to documentations, wiki, and/or examples enhancement New feature or request

Comments

@hadisfr
Copy link
Member

hadisfr commented Oct 30, 2018

AP students typically don't know anything about poll mechanism, and other technical phrases. Docs should be clearer and simpler and need less technical knowledge to be understood. (E.g. see docks for pollForEvent)
Also, there sohuld be a very simple single-file example in the repo. The current example is too complicated to be used by students.
@hadisfr hadisfr added enhancement New feature or request docs Related to documentations, wiki, and/or examples labels Oct 30, 2018
@hadisfr
Copy link
Member Author

hadisfr commented Nov 7, 2018

A single-file simpler example has been added via 9da3cf4.

@hadisfr
Copy link
Member Author

hadisfr commented Mar 27, 2019

@ahmad-PH Take a look at this before updating the wiki please.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Related to documentations, wiki, and/or examples enhancement New feature or request
Milestone
No milestone
Development

No branches or pull requests
1 participant
@hadisfr