From 45a19c8ceca7b3dc1328dc15523ca37dd43adbf6 Mon Sep 17 00:00:00 2001 From: Mateusz Pusz Date: Sun, 17 Nov 2024 13:32:02 +0100 Subject: [PATCH] docs: new chapter about our documentation added to the contributing guide --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f132e332..5d7671ed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,6 +3,17 @@ 👍🎉 First off, thanks for taking the time to contribute! 🎉👍 +## **mp-units** documentation + +Before contributing, it is highly recommended to familiarize yourself with our +[official documentation](https://mpusz.github.io/mp-units). + +This file is also a part of it, and this is why it has non-standard Markdown formatting (which can +be seen when reading in a regular Markdown renderer). To benefit from full mkdocs rendering, please +switch to the [Contributing](https://mpusz.github.io/mp-units/latest/getting_started/contributing) +chapter of our documentation. + + ## Where to start? If you are looking for a good issue to start with, please check the following: