openedx / docs.openedx.org

[BETA] A new home for learning about Open edX
https://docs.openedx.org
Other
6 stars 53 forks source link

chore: fixed typos #482

Closed CodeWithEmad closed 2 months ago

CodeWithEmad commented 3 months ago

As decided in #474, I'll break the big clean-up PR into smaller PRs for faster review/merge.

this will introduce:

openedx-webhooks commented 3 months ago

Thanks for the pull request, @CodeWithEmad! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

feanil commented 3 months ago

@CodeWithEmad this has some conflicts with your other PR that I merged, can you fix it up?

CodeWithEmad commented 3 months ago

Sure @feanil.

CodeWithEmad commented 3 months ago

Thank you @pdpinch for the review. I've added all the requested changes.

The existing docs often include a shell prompt ($) in code snippets, and this PR removes them.

The code blocks have a copy button in the website. Having the $ in the beginning causes unnecessary deletion for users who want to copy and use that command.

feanil commented 3 months ago

You can rebase merge, I only squash when it's clear there are a lot of intermediate temp commits. We turned off conventional commits on this repo to make it easier for less technical folks to make suggestions without needing to understand conventional commits.

openedx-webhooks commented 2 months ago

@CodeWithEmad 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

pdpinch commented 2 months ago

Thank you @CodeWithEmad!