From 6f8a5cb689a8e53c39d10da9fcc512a4ef1797cc Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Fri, 10 May 2024 12:59:55 -0400 Subject: [PATCH] update contributing info --- docs/CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index f405c51b9..21a74b7f1 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,8 +1,11 @@ -# About this documentation +# Contributing -This documentation is a work in progress and we wellcome any input: if something is missing or unclear, let us know by [opening an issue on our repository] (???). +### Contributing to the documentation -## Serving the doc locally +This documentation is a work in progress and we wellcome any input: +if something is missing or unclear, let us know by opening an issue on our repository. + +#### Serving the doc locally This project uses [MkDocs](https://www.mkdocs.org/) tool with [Material theme](https://squidfunk.github.io/mkdocs-material/) and extra plugins to generate the website.