[General Docs] Audit/Cleanup of Track General/Shared Docs

[Yrahcaz7]

This is a tracking issue for errors in the general docs on the Python track.

The docs are split into the below categories (general, shared, and other) depending on their location in the repo.

General Docs (docs/)

• PROBLEM-SOLVING.md:

  Addressed in PR 4253

  details

  • Line 4: Maybe italics or bold should be used instead of backticks.
  • Line 12: There should be a space after the comma.
  • Line 16: "The Programmers Brian" should be "The Programmer's Brain"
  • Line 18: There is two question marks in a row when there should be only one.
  • Line 19/30: The first link ("https://nostarch.com/algorithmic-thinking") now redirects to "https://nostarch.com/algorithmic-thinking-2nd-edition".
  • Line 20/40: The second link ("https://www.amazon.com/Computational-Thinking-Problem-Textbooks-Computing-ebook/dp/B00IZL9NQI") gives a 404 Not Found. It seems like there is a physical book version, though.
  • Line 20: There shouldn't be a period after the second link, the text after is part of the same sentence.
  • Line 21/42: The link seems to have a useless query string that may be used for tracking. This should be removed, giving the clean link.
  • Line 23: The acronym for "Association of Computing Machinery" should probably be mentioned, maybe written as "Association of Computing Machinery (ACM)".

• ABOUT.md:

  Addressed in PR 4254.

  details

  • Line 10/51: The "psf" link ("https://www.python.org/psf/") now redirects to "https://www.python.org/psf-landing/".
  • Line 10/49: The "peps" link ("https://www.python.org/dev/peps/") now redirects to "https://peps.python.org/".
  • Line 10: "Python Enhancement Proposals or PEPs" would be more clear that it is saying two different names for the same thing if it was written as "Python Enhancement Proposals (PEPs)".
  • Line 11: "persuasions" appears to be a typo, was it supposed to be "professions"?
  • Line 15: "(Jupyter notebook)" should probably be "(or Jupyter Notebooks)".
  • Line 20/62: "the zen of python" link ("https://www.python.org/dev/peps/pep-0020/") now redirects to "https://www.python.org/dev/peps/pep-0020/".
  • Line 20/64: The "what is pythonic" link ("https://blog.startifact.com/posts/older/what-is-pythonic.html") now redirects to "https://blog.startifact.com/posts/what-is-pythonic/".
  • Line 23: It is not immediately obvious that "3.10 - 3.13.5" refers to Python version numbers, "Python" or "version" should probably be added to clarify.

Shared Docs (exercises/shared/.docs/)

TBA

Other (CONTRIBUTING.md, README.md)

TBA

[github-actions]

Hello. Thanks for opening an issue on Exercism 🙂

At Exercism we use our Community Forum, not GitHub issues, as the primary place for discussion. That allows maintainers and contributors from across Exercism's ecosystem to discuss your problems/ideas/suggestions without them having to subscribe to hundreds of repositories.

This issue will be automatically closed. Please use this link to copy your GitHub Issue into a new topic on the forum, where we look forward to chatting with you!

If you're interested in learning more about this auto-responder, please read this blog post.

[Yrahcaz7]

@BethanyG, I finally got around to auditing two general docs: PROBLEM-SOLVING.md and ABOUT.md. Could you reopen this issue?