Update docs for main website #605
Conversation
Reviewer's Guide by SourceryThis pull request updates the documentation for the main website. The changes include a complete rewrite of the Quick Start guide, addition of front matter for titles, reformatting of tips and warnings to use blockquote style, and updating code block syntax highlighting across multiple files. Additionally, a new README file with links to all documentation sections was added, and two obsolete files were deleted. File-Level Changes
Tips
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @patrick91 - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 4 issues found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
docs/guide/filters.md
Outdated
| `foo: Optional[SomeType] = strawberry.UNSET` | ||
| Above `auto` annotation is wrapped in `Optional` automatically. | ||
| `UNSET` is automatically used for fields without `field` or with `strawberry_django.filter_field`. | ||
| > ![TIP] |
There was a problem hiding this comment.
issue (documentation): The markdown for the tip icon is incorrect. It should be [!TIP].
|
|
||
| It is highly recommended to enable the [Query Optimizer Extension](optimizer.md) | ||
| for improved performance and avoid some common pitfalls (e.g. the `n+1` issue) | ||
| > ![NOTE} |
There was a problem hiding this comment.
issue (documentation): The closing bracket for the note icon is incorrect. It should be [!NOTE].
| > ![NOTE] | ||
| > Even though `album__release_date` field was not selected here, it got selected | ||
| > in the prefetch query later. Since Django caches known objects, we have to select it here or | ||
| > else it would trigger extra queries latter. |
There was a problem hiding this comment.
issue (documentation): Typo in 'latter'. It should be 'later'.
docs/guide/filters.md
Outdated
| @@ -254,7 +256,7 @@ | |||
| - Important for nested filtering | |||
| - In code bellow custom filter `name` ends up filtering `Fruit` instead of `Color` without applying `prefix` | |||
|
|
|||
| ```{.python title="Why prefix?"} | |||
| ```python title=""Why prefix?"" | |||
There was a problem hiding this comment.
issue (documentation): Extra double quotes in the title. It should be title="Why prefix?".
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #605 +/- ##
=======================================
Coverage 88.84% 88.84%
=======================================
Files 41 41
Lines 3605 3605
=======================================
Hits 3203 3203
Misses 402 402 ☔ View full report in Codecov by Sentry. |
patrick91
force-pushed
the
feature/new-docs
branch
from
10cb5c5
to
f845a0c
Compare
.
Summary by Sourcery
This pull request significantly updates the documentation for the main website, including a comprehensive Quick Start guide and improved formatting for various guides and integration documents. It also introduces a new README file to better organize the documentation structure.