Fix typos and improve documentation clarity

[CodeWithEmad]

Corrected various typos in the codebase and enhanced documentation with syntax highlighting for better readability.
a rewrite of #156

@taimoor-ahmed-1 @Ali-Salman29

[openedx-webhooks]

Thanks for the pull request, @CodeWithEmad!

This repository is currently maintained by @openedx/wg-maintainers-forums.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

---

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[mphilbrick211]

Hi @openedx/wg-maintainers-forums! Would someone be able to review / merge this?

[mphilbrick211]

Hi @openedx/wg-maintainers-forums! Any chance we can get this looked at? It's been stalled a bit.

[sarina]

This PR needs a rebase.

[sarina]

i disagree with this change, because rendering this as a bash codeblock erroneously highlights bash keywords. I think this README is better with generic codeblocks for the shell commands. The python and yaml blocks are a value-add.

[sarina]

Is this going to have an effect outside of this app? I don't think correcting typos that exist as part of method or class names is worth potential downstream breakages.

[mphilbrick211]

Hi @CodeWithEmad - just checking in to see if you are still working on this?

[CodeWithEmad]

It's ready for review
@sarina @mphilbrick211

[sarina]

Looks like tests are failing @CodeWithEmad

[mphilbrick211]

Looks like tests are failing @CodeWithEmad

Flagging this for you, @CodeWithEmad