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

Add easy to understand examples #21

Open
TheKeymaster opened this issue Jan 17, 2019 · 0 comments
Open

Add easy to understand examples #21

TheKeymaster opened this issue Jan 17, 2019 · 0 comments
Assignees
@TheKeymaster
Labels
Priority: normal Normal priority.

Comments

@TheKeymaster
Copy link
Contributor

TheKeymaster commented Jan 17, 2019 •
edited
Loading

Examples should be in the README.md and in the Wiki

  • How do I start?
  • How do I get the data that I need?
  • I want to display filters how can I archive that?
  • I want to be able to request the autocomplete, how can I do that?
  • Examples should be simple enough to test. They also should
    • Show images of the result
    • Show the output of variables as comments
  • The code should also refer to the Wiki with the @see tags from PhpDoc.
@TheKeymaster TheKeymaster self-assigned this Jan 17, 2019
@TheKeymaster TheKeymaster added this to the v1.0.0-rc.1 milestone Jan 17, 2019
@TheKeymaster TheKeymaster added the Priority: normal Normal priority. label Jan 17, 2019
@TheKeymaster TheKeymaster removed this from the v1.0.0-rc.1 milestone Oct 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@TheKeymaster TheKeymaster

Labels
Priority: normal Normal priority.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@TheKeymaster