From c02075b9cc4ae8e182d0ef50170c1c4a6a49b82d Mon Sep 17 00:00:00 2001 From: Yannic Kilcher Date: Wed, 28 Dec 2022 22:02:46 +0100 Subject: [PATCH] added docs folder --- docs/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..9e1743d8 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,9 @@ +# Documentation + +This directory contains the documentation for the project and other related organization documents. + +## Contributing to this documentation + +Please make a pull request to the `main` branch with your changes. + +Consider that this folder is used for documenting the various code sub-parts, the high-level ideas, the ML aspects, experiments, contributor guides, guides for data creation, and many more things. Please try to keep the documentation as concise as possible and keep an organized folder structure that makes sense for everyone.