strawberry-graphql / strawberry-django

Strawberry GraphQL Django extension
MIT License
391 stars 115 forks source link

Added `export-schema` command to Docs #546

Closed Ckk3 closed 3 weeks ago

Ckk3 commented 3 weeks ago

Added export-schema command to Docs

Types of Changes

Issues Fixed or Closed by This PR

Checklist

Additional Information

I've also added the new page in the Guide menu:

image

Summary by Sourcery

This pull request adds new documentation for the export_schema management command, explaining its purpose, usage, and providing an example. The new documentation page has been added to the Guide section in the navigation menu.

sourcery-ai[bot] commented 3 weeks ago

Reviewer's Guide by Sourcery

This pull request adds documentation for the export-schema command, which is used to export a GraphQL schema defined using the strawberry_django library. The documentation includes usage instructions, arguments, options, and an example command. Additionally, the new documentation page is added to the Guide menu in the mkdocs.yml configuration file.

File-Level Changes

Files Changes
mkdocs.yml
docs/guide/export-schema.md
Added documentation for the export-schema command and updated the Guide menu to include the new documentation page.

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - You can change your review settings at any time by accessing your [dashboard](https://sourcery.ai/dashboard): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
codecov-commenter commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 88.63%. Comparing base (90e1878) to head (81a47cd).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #546 +/- ## ======================================= Coverage 88.63% 88.63% ======================================= Files 41 41 Lines 3433 3433 ======================================= Hits 3043 3043 Misses 390 390 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

Ckk3 commented 3 weeks ago

Please let me know if this PR need some changes!

bellini666 commented 3 weeks ago

Awesome! Thanks for this :)