From 551d98e6de12e80e6da734bb3ff2dbc85d4adf5b Mon Sep 17 00:00:00 2001 From: Sigurd Spieckermann <2206639+sisp@users.noreply.github.com> Date: Mon, 30 Oct 2023 21:14:42 +0100 Subject: [PATCH 1/2] Documentation (#6222) --- docs/getting-started.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 0465b5b2084..b6726f2e124 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -75,10 +75,12 @@ MkDocs on GitHub Pages in a step-by-step guide. --- -__Tip__: If you don't have prior experience with Python, we recommend reading -[Using Python's pip to Manage Your Projects' Dependencies], which is a really -good introduction on the mechanics of Python package management and helps you -troubleshoot if you run into errors. +!!! tip + + If you don't have prior experience with Python, we recommend reading + [Using Python's pip to Manage Your Projects' Dependencies], which is a + really good introduction on the mechanics of Python package management and + helps you troubleshoot if you run into errors. [Python package]: https://pypi.org/project/mkdocs-material/ [virtual environment]: https://realpython.com/what-is-pip/#using-pip-in-a-python-virtual-environment From 1698708b2329980453da332a2aafa39b0f654653 Mon Sep 17 00:00:00 2001 From: eleanor-arc-boats <113399976+eleanor-arc-boats@users.noreply.github.com> Date: Mon, 30 Oct 2023 13:45:13 -0700 Subject: [PATCH 2/2] Documentation (#6260) * Update reporting-a-bug.md fix discussion board link * space --- docs/contributing/reporting-a-bug.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/reporting-a-bug.md b/docs/contributing/reporting-a-bug.md index 5d40218b475..8c84f8a10db 100644 --- a/docs/contributing/reporting-a-bug.md +++ b/docs/contributing/reporting-a-bug.md @@ -66,7 +66,7 @@ problems.__ [hooks]: https://www.mkdocs.org/user-guide/configuration/#hooks [extra_css]: https://www.mkdocs.org/user-guide/configuration/#extra_css [extra_javascript]: https://www.mkdocs.org/user-guide/configuration/#extra_javascript - [discussion board]: https://github.com/squidfunk/mkdocs-material/issues + [discussion board]: https://github.com/squidfunk/mkdocs-material/discussions [StackOverflow]: https://stackoverflow.com [that our documentation explicitly mentions]: ?q="extends+base"