Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

docs: fixed md formatting, misspellings and broken links #316

Open
wants to merge 14 commits into
base: staging
Choose a base branch
from

Conversation

czar0
Copy link

@czar0 czar0 commented Jan 29, 2023

Description

As an eager student (and great fan! 😄) of this fantastic course, I wanted to provide a small contribution to it by fixing some minor "bugs" I encountered here and there while going through those pages.
Most of the corrections have been done using automated tools (see list below) and then checked manually.

Changes

  • Fixed all markdown formatting
  • Corrected misspellings in en-US locale
  • Fixed broken links and replaced missing resources (e.g. deleted tweets) with Internet Archive page when available
  • Replaced all HTML code with equivalent markdown syntax
  • Escaped _ character in all {target=_blank} to avoid conflicts with italicize markdown syntax
  • Added {target=\_blank} to all hyperlinks
  • Added some TODOs for easier issue tracking

Tooling

  • Markdown syntax corrections based on markdownlint's VSCode extension rules
  • Markdown formatting using commonmark (integrated into prettier code formatted)
  • Markdown syntax highlighting based on linguist (supported by GitHub's processor)
  • Spell check using Code Spell Checker for en-US

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant