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

Rework documentation #158

Open
kindermax opened this issue Aug 8, 2024 · 1 comment
Open

Rework documentation #158

kindermax opened this issue Aug 8, 2024 · 1 comment
Milestone
Schema high-level...

Comments

@kindermax
Copy link
Collaborator

kindermax commented Aug 8, 2024 •
edited
Loading

Collecting ideas for a better docs

Hiku documentation lacks the following pages IMHO:

  • Low level api - about Engine, Executors, validation
  • High level api - about Schema and Endpoints

Tutorials / Examples - we need more examples for how to:

  • write tests
  • use extensions
  • write Exectuor
  • deny sync resolvers in async graph
  • etc.

Architecture - how hiku works
@kindermax kindermax added this to the Schema high-level api milestone Sep 14, 2024
@kindermax
Copy link
Collaborator Author

Add section Query builder that describes how to use

query = build([ Q.foo[Q.bar] ])

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Schema high-level api
Development

No branches or pull requests
1 participant
@kindermax