Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[Docs] Tidy up the Modal tutorial #17367

Merged
merged 9 commits into from
Mar 5, 2025
Merged

Conversation

daniel-prefect
Copy link
Contributor

@daniel-prefect daniel-prefect commented Mar 4, 2025

This is a follow-up to #17345. We decided to address style and formatting in a separate PR rather than slowing down our external contributor.

Preview: https://prefect-bd373955-tidy_the_modal_tutorial.mintlify.app/v3/tutorials/modal

A few of the tweaks I made (not an exhaustive list):

  • Fix capitalization (e.g. GitHub, Modal, Prefect).
  • Replace 'we' and 'our' with 'you' and 'your'.
  • Use ventilated prose.
  • Assign links the name of the linked page instead of "here" or "this".
  • Utilize numbered lists in places with tightly coupled steps.
  • Put terminal commands on a new line (as opposed to being inline with prose) so that it's more obvious what you're supposed to run.
  • Show the proper name of UI elements and format them in bold.

Checklist

  • This pull request references any related issue by including "closes <link to issue>"
  • If this pull request adds new functionality, it includes unit tests that cover the changes
  • If this pull request removes docs files, it includes redirect settings in mint.json.
  • If this pull request adds functions or classes, it includes helpful docstrings.

@daniel-prefect daniel-prefect marked this pull request as ready for review March 5, 2025 01:09
Copy link
Collaborator

@zzstoatzz zzstoatzz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is great! thanks for the cleanup @daniel-prefect 🎉

Co-authored-by: Sean <66645429+seanpwlms@users.noreply.github.com>
@daniel-prefect daniel-prefect merged commit 459cb47 into main Mar 5, 2025
6 checks passed
@daniel-prefect daniel-prefect deleted the tidy_the_modal_tutorial branch March 5, 2025 20:45
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants