From 68f2381ca4be9a78e2f991fc70357a7d28508bbc Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 1 Jan 2023 17:35:34 +0100 Subject: [PATCH] Documentation --- docs/bug-report/index.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/bug-report/index.md b/docs/bug-report/index.md index 15c2f53b5..6c7b841cd 100644 --- a/docs/bug-report/index.md +++ b/docs/bug-report/index.md @@ -171,7 +171,16 @@ relevant. Don't write about the bug here. Now, to the bug you want to report. Provide a clear, focused, specific and concise summary of the bug you encountered. Explain why you think this is a bug that should be reported to Material for MkDocs, and not to one of its -[dependencies]. Adhere to the following principles: +dependencies.[^3] Adhere to the following principles: + + [^3]: + Sometimes, users report bugs on our [issue tracker] that are caused by one + of our upstream dependencies, including [MkDocs], [Python Markdown], + [Python Markdown Extensions] or third-party plugins. A good rule of thumb is + to change the [`theme.name`][theme.name] to `mkdocs` or `readthedocs`, and + check if the problem persists. If it does, the problem is likely not + related to Material for MkDocs and should be reported upstream. When in + doubt, use our [discussion board] to ask for help. - __Explain the what, not the how__ – don't explain [how to reproduce the bug][Steps to reproduce] here, we're getting there. @@ -195,7 +204,10 @@ we maintainers can fix the bug in our code base. > need a clear description of the problem and its impact, which is essential > for triage and prioritization. - [dependencies]: #dependencies + [MkDocs]: https://www.mkdocs.org + [Python Markdown]: https://python-markdown.github.io/extensions/ + [Python Markdown Extensions]: https://facelessuser.github.io/pymdown-extensions/ + [theme.name]: https://www.mkdocs.org/user-guide/configuration/#theme ### Related links