chore(docs): improving the docs (#115)

* chore(docs): improving the docs

This improves the docs as suggested by some reddit user. Now, most of Manim is documented in one place

* try: update lockfile

* chore(deps): remove duplicate key

* fix(ci): isort issue

See https://github.com/home-assistant/core/issues/86892

* fix(ci): bad identation

* fix(ci): fixing lock file

* fix(example): issue when ManimGL does not count wait as animation

docs/source/contributing/index.md

@@ -0,0 +1,21 @@
+# Contributing
+
+Thank you for your interest in Manim Slides! ✨
+
+Manim Slides is an open source project, first created as a fork of [manim-presentation](https://github.com/galatolofederico/manim-presentation) (now deprecated in favor to Manim Slides), and we welcome contributions of all forms.
+
+This section is here to help fist-time contributors know how they can help this project grow. Whether you are already familiar with Manim or GitHub, it is worth taking a few minutes to read those documents!
+
+
+```{toctree}
+:hidden:
+
+workflow
+internals
+```
+
+[Workflow](./workflow)
+: how to work on this project. Start here if you're a new contributor.
+
+[Internals](./internals)
+: how Manim Slides is built and how the various parts of it work.

docs/source/contributing/internals.md

@@ -0,0 +1,11 @@
+# Internals
+
+Manim-Slides' work in split in two steps: first, when rendering animation, and, second, when converting multiple animations into one slides presentation.
+
+## Rendering
+
+To render animations, Manim Slides simply uses Manim or ManimGL, and creates some additional output files that it needs for the presentation.
+
+## Slides presentation
+
+Manim Slides searches for the local artifacts it generated previously, and concatenates them into one presentation. For the graphical interface, it uses `PySide6`.

docs/source/contributing/workflow.md

@@ -0,0 +1,57 @@
+# Workflow
+
+This document is there to help you recreate a working environment for Manim Slides.
+
+## Dependencies
+
+```{include} ../../../README.md
+:start-after: <!-- start deps -->
+:end-before: <!-- end deps -->
+```
+
+## Forking the repository and cloning it locally
+
+We used GitHub to host Manim Slides' repository, and we encourage contributors to use git.
+
+Useful links:
+
+* [GitHub's Hello World](https://docs.github.com/en/get-started/quickstart/hello-world).
+* [GitHub Pull Request in 100 Seconds](https://www.youtube.com/watch?v=8lGpZkjnkt4&ab_channel=Fireship).
+
+Once you feel comfortable with git and GitHub, [fork](https://github.com/jeertmans/manim-slides/fork) the repository, and clone it locally.
+
+As for every Python project, using virtual environment is recommended to avoid conflicts between modules. For Manim Slides, we use [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer). If not already, please install it.
+
+## Installing Python modules
+
+With Poetry, installation becomes straightforward:
+
+```bash
+poetry install
+```
+
+## Running commands
+
+As modules were installed in a new Python environment, you cannot use them directly in the shell.
+Instead, you either need to prepend `poetry run` to any command, e.g.:
+
+```bash
+poetry run manim-slides wizard
+```
+
+or enter a new shell that uses this new Python environment:
+
+```
+poetry run
+manim-slides wizard
+```
+
+## Testing your code
+
+Most of the tests are done with GitHub actions, thus not on your computer. The only command you should run locally is `pre-commit run --all-files`: this runs a few linter and formatter to make sure the code quality and style stay constant across time. If a warning or an error is displayed, please fix it before going to next step.
+
+## Proposing changes
+
+Once you feel ready and think your contribution is ready to be reviewed, create a [pull request](https://github.com/jeertmans/manim-slides/pulls) and wait for a reviewer to check your work!
+
+Many thanks to you!