Documentation meta issue

[patrick91]

General

• [x] Getting started (https://strawberry.rocks/docs/)
• [x] Schema Basic (https://strawberry.rocks/docs/schema-basics)
• [x] Query Basics @jaydenwindle (https://strawberry.rocks/docs/queries)
• [x] Mutation Basics (https://strawberry.rocks/docs/mutations)
• [x] Subscriptions Basics
• [x] Why strawberry (code first, batteries included, dataclasses) #603

Types

• [ ] Fields (#450)
  • [ ] Private fields (https://github.com/strawberry-graphql/strawberry/pull/479)
• [ ] Input types
• [x] Interfaces
• [ ] Generics
• [x] Custom scalars
• [x] Enums
• [x] Union
• [ ] Schema directives
• [ ] Resolvers

Integrations @jaydenwindle

• [x] Django support
• [x] Flask support
• [x] ASGI Support

Features

• [x] 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)
• [x] 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/

[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 https://github.com/strawberry-graphql/strawberry/issues/1879#issuecomment-1170782910 LazyType should be added to the list above as a way to deal with circular dependencies 😊