From 317a36bf426d1a7212fc7ae82cf885ba3beadd13 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Astor?= Date: Thu, 17 Sep 2020 00:11:20 +0200 Subject: [PATCH] Create ContributingDocumentation.mdr --- .../ContributingDocumentation.mdr | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 docs/Contributing/ContributingDocumentation.mdr diff --git a/docs/Contributing/ContributingDocumentation.mdr b/docs/Contributing/ContributingDocumentation.mdr new file mode 100644 index 00000000..c85a7d94 --- /dev/null +++ b/docs/Contributing/ContributingDocumentation.mdr @@ -0,0 +1,44 @@ +# Contributing Documentation + +> this is a stub for now, this place deserves better + +You might be here because you found something you could improve in [Gwion](https://github.com/fennecdjay/Gwion)'s documentation. +Please open a [issue](https://github.com/fennecdjay/gwion-docs/issues) describing the problem and how you might address it. + + +## Dependencies + + * Gwion + * mdr + * MdBook + +## Editing the documentation + +### Clone the source + +``` sh +git clone https://github.com/fennecdjay/gwion-docs +``` + +### Edit some files + +``` sh +cd gwion-docs +make watch +``` + +### Add your changes + +``` sh +git add docs/myfile.mdr +``` + +### Let the world know + +``` sh +git commit -m "Something meaningful about why we are here" +git push +``` + +You're now ready to submit a [PullRequest](https://github.com/fennecdjay/gwion-docs/pulls). + -- 2.43.0