Documentation meta issue

[patrick91]

General

• Getting started (https://strawberry.rocks/docs/)
• Schema Basic (https://strawberry.rocks/docs/schema-basics)
• Query Basics @jaydenwindle (https://strawberry.rocks/docs/queries)
• Mutation Basics (https://strawberry.rocks/docs/mutations)
• Subscriptions Basics
• Why strawberry (code first, batteries included, dataclasses) Add some docs on why we created strawberry and why use it #603

Types

• Fields (Field documentation #450)
  • Private fields (Add a Private class to exclude fields from the schema #479)
• Input types
• Interfaces
• Generics
• Custom scalars
• Enums
• Union
• Schema directives
• Resolvers

Integrations @jaydenwindle

• Django support
• Flask support
• ASGI Support

Features

• Error handling

  • 1. what happens when there's an exception in the code (and how to debug if we manage to improve things there)
    2. validation errors, ie when sending bad queries/inputs
    3. expected errors vs unexpected errors

• File uploads
• Authentication
• Pagination
• Permissions
• Federation (experimental)
• Extensions (https://strawberry.rocks/docs/feature/extensions)

Operation

• Tracing / profiling (https://strawberry.rocks/docs/ops/tracing)
• Testing
• Deployment

Demos

• SWAPI
• Subscription
• More

---

Examples of good documentation

• https://docs.djangoproject.com/en/3.1/
• https://graphql.org/learn/

Useful resources

• https://developers.google.com/tech-writing
• https://www.writethedocs.org/
• https://documentation.divio.com/

Upvote & Fund

• We're using Polar.sh so you can upvote and help fund this issue.
• We receive the funding once the issue is completed & confirmed by you.
• Thank you in advance for helping prioritize & fund our backlog.

[skilkis]

@patrick91 based on your reply in the Discord, I think resolver arguments could also be added to this list. The following is quite handy to know:

def resolver(python_name_argument: Annotated[str, strawberry.argument(name="graphqlName")]): ...

[skilkis]

Based on #1879 (comment) LazyType should be added to the list above as a way to deal with circular dependencies 😊