docs: General doc improvements (#610)

strawberry-graphql · Jul 30, 2024 · 9c7fe90 · 9c7fe90
1 parent 5faefc3
commit 9c7fe90
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 21 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -4,35 +4,38 @@ title: Strawberry Django docs
 
 # Strawberry Django docs
 
-## General
+## Docs
 
-- [Index](./index.md)
-- [Community Projects](./community-projects.md)
-- [FAQ](./faq.md)
+- [Getting Started](./index.md)
 
-## Guide
+## General
 
-- [Authentication](./guide/authentication.md)
-- [Export Schema](./guide/export-schema.md)
+- [Types](./guide/types.md)
 - [Fields](./guide/fields.md)
+- [Views](./guide/views.md)
 - [Filters](./guide/filters.md)
-- [Mutations](./guide/mutations.md)
-- [Optimizer](./guide/optimizer.md)
 - [Ordering](./guide/ordering.md)
 - [Pagination](./guide/pagination.md)
-- [Permissions](./guide/permissions.md)
 - [Queries](./guide/queries.md)
+- [Mutations](./guide/mutations.md)
+- [Subscriptions](./guide/subscriptions.md)
+- [Settings](./guide/settings.md)
+- [FAQ](./faq.md)
+
+## Guide
+
+- [Query Optimizer](./guide/optimizer.md)
+- [Permissions](./guide/permissions.md)
 - [Relay](./guide/relay.md)
+- [Authentication](./guide/authentication.md)
+- [Export Schema](./guide/export-schema.md)
 - [Resolvers](./guide/resolvers.md)
-- [Settings](./guide/settings.md)
-- [Subscriptions](./guide/subscriptions.md)
-- [Types](./guide/types.md)
 - [Unit Testing](./guide/unit-testing.md)
-- [Views](./guide/views.md)
 
 ## Integrations
 
+- [Debug Toolbar](./integrations/debug-toolbar.md)
 - [Channels](./integrations/channels.md)
 - [Choices Field](./integrations/choices-field.md)
-- [Debug Toolbar](./integrations/debug-toolbar.md)
-- [Guardian](./integrations/guardian.md)
+- [Django Guardian](./integrations/guardian.md)
+- [Community Projects](./community-projects.md)
diff --git a/docs/community-projects.md b/docs/community-projects.md
@@ -6,10 +6,10 @@ title: Community Projects
 
 Those are some community maintained projects worth mentioning:
 
-|                                             Project                                              |                                                         Description                                                         |
-| :----------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------: |
-|  [:material-github: strawberry-django-auth](https://github.com/nrbnlulu/strawberry-django-auth)  |                          :material-information: Authentication System for Django using Strawberry.                          |
-| [:material-github: strawberry-django-extras](https://github.com/m4riok/strawberry-django-extras) | :material-information: JWT Authentication, Input validation and permissions, mutation hooks and deeply nested CUD mutations |
+|                                      Project                                      |                                             Description                                              |
+| :-------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------: |
+|  [🐙 strawberry-django-auth](https://github.com/nrbnlulu/strawberry-django-auth)  |                          Authentication System for Django using Strawberry.                          |
+| [🐙 strawberry-django-extras](https://github.com/m4riok/strawberry-django-extras) | JWT Authentication, Input validation and permissions, mutation hooks and deeply nested CUD mutations |
 
 If you want your integration to be listed here, send us a
 [Pull Request](https://github.com/strawberry-graphql/strawberry-django/pulls)
diff --git a/docs/guide/ordering.md b/docs/guide/ordering.md
@@ -77,7 +77,8 @@ class FruitOrder:
 > Do not use `queryset.order_by()` directly. Due to `order_by` not being chainable
 > operation, changes applied this way would be overriden later.
 
-> [!TIP] > `strawberry_django.Ordering` has convenient method `resolve` that can be used to
+> [!TIP]
+> The `strawberry_django.Ordering` type has convenient method `resolve` that can be used to
 > convert field's name to appropriate `F` object with correctly applied `asc()`, `desc()` method
 > with `nulls_first` and `nulls_last` arguments.